# Context Editor
Source: https://docs.cloud.cdata.com/en/Context-Editor

Improve query accuracy and reply times, and save tokens by providing business terms, dataset definitions, and column mappings that the MCP server uses to interpret your prompts.

<Note>The Context Editor is currently in beta as part of an early access program. More information about joining the program is available on the [CData AI page](https://www.cdata.com/ai).</Note>

The Context Editor gives AI models the business knowledge they need to translate natural language prompts into accurate data queries. You can import context from an existing resource (add external context), or create context manually using the built-in editor (add new context).

The left pane of the **Context Editor** page (in list view) contains **User Context** and **Global Context**.

## User Context

User context is the information about yourself that Connect AI sends to the AI automatically: once at the beginning of each conversation when you use the LLM Gateway, and together with the results of the `search_context` tool when you use the MCP server. You can add information such as your role, what kind of answers you prefer, and your time zone. The editor supports Markdown. You can add or edit information on this page or in the **User Context** tab of **Settings**.

## Global Context

Global context manages what AI agents know about your data.

### List View

Click **Global Context** and the list view icon to view a list of all the entities in your account and the number of named contexts assigned to them. The named contexts directly under **Global Context** apply to all connections and datasets, and you can have many of them. Use the search bar to find an entity. Expand an entity in the left pane to view the named contexts assigned to it. Click **+ Add Context** to add a new context or a new external context.

### Graph View

Click **Global Context** and the graph view icon to view a context graph of all the context entities and how they relate to each other across the semantic layer. Use the search bar to find an entity in the graph.

<Frame>
  <img alt="Context graph showing context editor entities and their relationships across the semantic layer" />
</Frame>

The context graph contains the following entity types:

* **Global Context**: The account-level context that applies to all connections and datasets. Use Global Context to define terms and rules that span your entire data environment.
* **Connection**: A named data source (for example, *MailChimp* or *PostgreSQL*). Context defined at the connection level applies to all datasets within that connection.
* **Dataset**: A table or query within a connection. Dataset-level context provides field-specific details to help the MCP server interpret queries against that dataset.
* **Metric**: A reusable measure defined on one or more fields. Metrics are created by importing a dbt semantic layer or a Snowflake semantic view.
* **Glossary**: Business terms, rules, and other business knowledge, optionally linked to columns. Glossary entries let the MCP server recognize business language. For example, map *Revenue* to the `total_sales` column so that prompts return accurate results.

### View Context Details

In list view or graph view, click an entity to view details about the entity.

<Frame>
  <img alt="Context details panel for a selected entity" />
</Frame>

## Add Context

There are two ways to add context:

* **Options menu**: Click the options menu (⋮) to the right of an entity to add context directly to that entity.
* **Add Context button**: Click **Add Context** to add context. You must select the entity type to apply it to: a specific connection or global context that applies to all connections and datasets.

You can import context from a dbt or Power BI file, or generate context using AI. You can also add new context manually by editing a context template.

### Add External Context

Use Add External Context to add semantic context globally or to a connection. The connection appears as the parent, with an expandable list of its datasets below it.

<Steps>
  <Step>
    Click **+ Add Context > Add External Context**. A dialog appears.
  </Step>

  <Step>
    In **Step 1** of the dialog, select a resource from the list of connections, or select **Global Context** to apply the context to all connections and datasets. Use the search bar to narrow down your search.
  </Step>

  <Step>
    Click **Next**.
  </Step>

  <Step>
    In **Step 2** of the dialog, select the **Source** of the semantic context: **dbt** or **Power BI**. Alternatively, you can have Connect AI generate context using AI.

    * For **dbt**, paste the contents of `manifest.json` in the space below.
    * For **Power BI**, select the Power BI (.pbix) file containing the semantic context.
      <Note>Snowflake connection context has an additional option: a **Snowflake Semantic View** YAML file.</Note>
    * For **Generate Context**, under **Tables** select **Generate context from all tables** or **Generate context from selected tables**. With selected tables, pick the tables in the list that appears. Toggle **Include Sample Values** on to improve accuracy, then click **Generate**. Sample values are available only when they are allowed in **Settings > Security** and the account has no HIPAA BAA; when the toggle is on, sample rows from the selected tables are sent to the LLM.

      **Generate Context** requires an authenticated connection, because it reads the tables through that connection. For a connection where each user signs in with their own credentials, the user generating context must have authenticated it themselves.

      You can close this dialog and Connect AI continues to generate context in the background.

      <Note>Generated context cannot be used on global context, only connection context.</Note>
  </Step>

  <Step>
    Click **Add** to add the context, or click **Generate** to generate context. The new context appears in the list under the resource you selected in Step 1: under Global Context, or under the connection with its datasets listed below it.
  </Step>
</Steps>

### Add New Context

To add a new context document manually to Global Context or to a connection, do the following:

<Steps>
  <Step>
    Click **+ Add Context > Add New Context**. A dialog appears.
  </Step>

  <Step>
    In **Step 1** of the dialog, select a resource from the list of connections, or select **Global Context** to apply the context to all connections and datasets. Use the search bar to narrow down your search.
  </Step>

  <Step>
    Click **Next**.
  </Step>

  <Step>
    In **Step 2** of the dialog, enter a name for the new context.
  </Step>

  <Step>
    Click **Add**.
  </Step>

  <Step>
    Edit the context template to define terms, relationships, or business rules that help the MCP server interpret your prompts accurately. See [Example: Jira Issues Dataset](#example-jira-issues-dataset) for a completed template.
  </Step>

  <Step>
    Click **Save**.
  </Step>
</Steps>

### Example: Jira Issues Dataset

The context template uses the following fields:

* **type**–The kind of concept, which can be `dataset` (a table or view), `metric` (a measure), or `glossary` (a business term or rule). All context created in the editor (not imported) is saved as `type: glossary`.
* **title**–The name of the concept as it appears in the context graph.
* **semanticType**–Your own sub-classification, in free text (for example, `fact_table`, `dimension`, or `kpi`). Connect AI stores it with the concept but does not use it for grouping or matching.
* **synonyms**–Other names users might type when asking about this concept. Include the words your users actually use.

In the body of the template:

* **Heading and Description**–Tell the MCP server what the concept covers and when it is relevant.
* **Related**–Other concepts this one depends on or explains.
* **Columns** (datasets only)–The fields that carry meaning, with descriptions. Remove this section for a glossary term or metric.

The following example shows a completed context file for a Jira Issues dataset.

```text wrap theme={null}
---
type: dataset
title: Jira Issues
semanticType: fact_table
synonyms:
  - tickets
  - tasks
  - bugs
  - stories
---

# Jira Issues

Contains all issues tracked in Jira, including bugs, tasks, stories, and epics.
Use this dataset to query issue status, assignments, priorities, and project breakdowns.

## Related

- Jira Projects
- Jira Users

## Columns

- **issue_key**—unique identifier for the issue (for example, PROJ-123)
- **summary**—short description of the issue
- **status**—current workflow state (for example, *To Do*, *In Progress*, *Done*)
- **assignee**—the user assigned to the issue
- **priority**—severity level (for example, *High*, *Medium*, *Low*)
- **project**—the Jira project the issue belongs to
- **issue_type**—category of issue (for example, *Bug*, *Story*, *Epic*, *Task*)
```

## Delete Context

To delete a context document:

<Steps>
  <Step>
    Click the delete icon next to the individual concept. To delete all concepts for a connection, click the options menu (⋮) to the right of the connection and click **Delete**.
  </Step>

  <Step>
    In the confirmation dialog, click **Delete**. When you delete all context for a connection, the button is **Delete all**; the connection itself is not deleted. Deleting context cannot be undone.
  </Step>
</Steps>


# Dashboard
Source: https://docs.cloud.cdata.com/en/Dashboard

The ***Dashboard*** page opens when you log in to Connect AI. It provides a high-level overview of recent queries and account activity.

<Frame>
  <img alt="Dashboard" />
</Frame>

In the upper-right corner of the page, you can click **1 Day**, **7 Days**, or **30 Days** to adjust the data shown. Connect AI refreshes the page and updates the displayed data accordingly.

## Quick Actions

The quick actions section provides links to the most commonly-used functions in Connect AI.

* **Discover Data with AI:** This action provides links to [**Playground**](/en/Playground) for AI-generated insights with no setup required, and to [**MCP Integrations**](/en/Integrations#ai-tools) for AI insights via your favorite AI integration tool.
* **Set Up Connection:** This action takes you to the [**Sources**](/en/Sources) page to view and add data connections.
* **Explore Data:** This action takes you to the [**Data Explorer**](/en/Data-Explorer), where you can use the [**Query Builder**](/en/QueryBuilder) or the [**SQL Editor**](/en/Data-Explorer#create-a-query-in-the-sql-editor) to explore your connected data.
* **Connect Integrations:** This action takes you to the [**Integrations**](/en/Integrations) page, where you can visualize data with your favorite integration tool.

## Analytics

The analytics section displays the quantity for each of these four categories in the selected time period:

* **Rows:** The rows that are processed
* **Queries:** The queries that are performed
* **Active Connections:** The active connections on your account
* **Active Users**: The active users in your account
  <Frame>
    <img alt="Information boxes" />
  </Frame>

Underneath the count, each box displays the percentage change compared to the previous time period. This percentage change adjusts dynamically based on the time period that is selected.

## Data Visuals

Under the analytics section, the **Dashboard** page displays three visuals:

* **Queries Over Time**
* **Queries by Connection**
* **Queries by User**

### Queries Over Time

This bar graph shows the total number of queries that are made through your Connect AI account over the selected time period. The x-axis displays the dates, and the y-axis displays the number of queries.

<Frame>
  <img alt="Queries Over Time" />
</Frame>

Each bar is composed of two sections:

* The number of successful queries, displayed top portion of the bar and colored blue
* The number of failed queries, displayed as the bottom portion of the bar and colored red

Clicking the down arrow icon in the upper-right corner of the section opens an export menu. This menu enables you to export the graph as a data file.

### Queries by Connection

This table displays the number of queries that are made by each connection in the selected time period.

<Frame>
  <img alt="Queries by Connection" />
</Frame>

There are three columns in this table:

* **Connection:** The name that is given to the connection on the **Connections** tab
* **Queries:** The total number of queries, both successful and failed, that are made by the connection in the selected time period
* **Successful:** The percentage of queries from the connector that succeed in the selected time period

Clicking the name of a column sorts the table by that column. If the table is already sorted by the selected column, the sort function toggles between ascending and descending order.

### Queries by User

This table provides a detailed breakdown of the queries that are made by each user in the selected time period.

<Frame>
  <img alt="Queries by User" />
</Frame>

There are five columns in this table:

* **User:** The name of the user who performs the queries
* **Queries:** The number of queries that are performed by the user in the selected time period
* **Rows:** The number of rows that are processed by the user in the selected time period
* **Errors:** The number of failed queries for the user in the selected time period
* **Last Query:** The date and time of the user’s last query, formatted as *YYYY*-*MM*-*DD* *HH*:*MM*:*SS* UTC

Clicking the name of a column sorts the table by that column. If the table is already sorted by the selected column, the sort function toggles between ascending and descending order.


# Data Explorer
Source: https://docs.cloud.cdata.com/en/Data-Explorer

The ***Data Explorer*** page enables you to execute basic queries on your connected data sources, browse your data models, and create derived views. You can also create saved queries, add assets to a workspace, and create cache jobs.

Data Explorer can be useful to:

* Verify that your data sources are connected correctly
* Explore the columns and data types that are available in your data sources
* Search for specific data in your data sources using the SQL Editor or the [Query Builder](/en/QueryBuilder).

When you first open Data Explorer, the interface displays a navigation pane on the left and the query editor on the right. Select whether you want to build your query in the Query Builder or the SQL Editor. If you click **Build Query**, the Query Builder guides you through the steps of creating a query. If you click **SQL Editor**, an SQL editor appears.

<Frame>
  <img alt="Data Explorer" />
</Frame>

<Note>Alternatively, you can use AI to explore your data. Click **Get Started** to launch [Playground](/en/Playground) or [MCP Integrations](/en/Integrations).</Note>

You can use the Data Explorer to view workspaces, saved queries, derived views, and connections. Click the arrow to the right to view the contents of the connection or workspace. Connections may consist of multiple schema. If there is only one schema in a connection, the schema is already open to a list of tables in the schema. If there are multiple schemas, open the desired schema to view the list of tables.

You can use the search bar to search for connections. Once you are within a connection, you can use the search bar to search for schemas and tables.

At any time in the Data Explorer, you can click the **Home** tab on the right side to select between Query Builder and SQL Editor. You can also click the plus button to add a new tab of your choice (Query Builder or SQL Editor). The tab titles display whether the query is a Query Builder query or a SQL Editor query.

## Use the SQL Editor

The SQL Editor allows you to create, modify, and save queries.

<Note>
  For instructions on using the Query Builder to build queries, refer to [Query Builder](/en/QueryBuilder).
</Note>

### Create a Query in the SQL Editor

Follow these steps to execute a query using the SQL Editor in the Data Explorer:

<Steps>
  <Step>
    Select a table or view in a connection or workspace, or select a saved query or derived view. All available items appear in the left column.

    * The solid table icon indicates a table.
    * The dashed square icon indicates a view.
    * The blue double document icon to the right of the item indicates that the item is being cached. See [Caching](/en/Caching) for more information.
  </Step>

  <Step>
    Select the data that you want to query.

    * To view the SQL query for an entire table or view, click that table or view. Alternatively, click the three dots next to the table or view and select **Open**. The SQL query appears on the right. Column details appear below the SQL query. This query is read-only until you execute it.
    * Click the three dots next to the table or view and select **Query** to create a new query based on the table or view. You can edit the query before you execute it.
    * Some data source types contain SQL templates for commonly-used queries. These queries appear under **Common Queries** when you expand the connection name. Click the three dots next to the query name and click **Query** to view the query. You can edit the query, if needed, before you execute it.

    Alternatively, you can enter a query manually by clicking the + sign in the tab bar and selecting **SQL Editor**. Use SQL syntax in the SQL Editor. Connect AI has an autocomplete feature to assist you with SQL syntax.

    <Frame>
      <img alt="SQL syntax help" />
    </Frame>

    The SQL Editor also autocompletes connection, schema, and table names. Once you pick a connection, autocomplete lets you select a schema from a drop-down list. You can then select a table within the schema.

    <Frame>
      <img alt="Autocomplete" />
    </Frame>
  </Step>

  <Step>
    Set the **Limit** field to the number of results that you want to return. By default, the limit is 100. You can set any limit, but you MUST enter a value in this field. (Do not use the SQL LIMIT clause.)
  </Step>

  <Step>
    Click **Execute** to run the query.

    When you execute the query, a loading icon appears in the **Results** section, along with a time elapsed notification. The loading icon also appears in the query's tab.

    If your time elapsed exceeds five minutes, please contact [CData support](https://www.cdata.com/support/submit.aspx) for assistance.
  </Step>

  <Step>
    When the query is finished executing, your results appear under the query editor. You can scroll through pages and adjust the number of results per page by using the fields at the bottom of the page. You can also adjust the column widths of the results.

    If your query returns an error, an error message appears above the query. An error icon also appears in the query's tab. Click **Learn More** for more details about the error.

    <Frame>
      <img alt="Query error" />
    </Frame>
  </Step>
</Steps>

### Modify a Query

After a read-only query executes, a new tab appears with a name such as **Query 1**. You can then modify the query and save it with a new name.

* Modify the query manually by entering query parameters into the query editor.
* Clear the query editor by selecting **Clear** and then clicking **OK** in the prompt that is displayed.

### Save a Query

Data Explorer provides the ability to save queries and return to them later without the need to re-enter the query parameters each time.

After you create and successfully execute a query, the **Save** button at the top of the Data Explorer pane becomes available. Follow these steps to save a query and access it later:

<Steps>
  <Step>
    Click **Save** > **Save as Saved Query**. The **Save Query** dialog appears.
  </Step>

  <Step>
    Enter a name for the query and click **Confirm**.
  </Step>

  <Step>
    The Data Explorer Saved Queries menu opens, and your newly-saved query appears in the list.
  </Step>
</Steps>

<Tip>
  You can also click the down arrow to the right of the query's tab and select **Rename Tab**. Rename the query and click **Confirm**.
</Tip>

#### Use Saved Queries

Saved queries are available in the **Saved Queries** folder in the Data Explorer navigation pane, and saved derived views are available in the **Derived Views** folder. To execute a saved query, click the three dots next to the saved query name and select **Query**. The contents of the saved query populate in the Query Editor, and you can click **Execute** to retrieve the results.

You can also rename and delete saved queries when you click the three dots.

## Add to a Workspace

You can use the Data Explorer to add assets to a workspace.

<Steps>
  <Step>
    Click the table or view you want to add to a workspace. Connect AI calls contents of a workspace *assets*.
  </Step>

  <Step>
    Click the three dots next to the asset and select **Add to Workspace**.
  </Step>

  <Step>
    Select the workspace to move the asset to and click **Confirm**.
  </Step>
</Steps>

## Configure Derived Views

The *derived views* feature of Data Explorer allows you to create and save queries that return dynamically populated data results from your connections. You can query your saved derived views from [Integrations](/en/Integrations), and the results automatically update when the data in your connections changes.

<Note>
  Only administrators of Connect AI can create or modify derived views. Query users can query saved derived views created by an administrator.
</Note>

### Create a Derived View

To create a new derived view, follow these steps:

<Steps>
  <Step>
    Create the query in the Query Builder or SQL Editor. After you execute the query, the **Save** button appears. Click **Save** > **Save as Derived View**. The **Create Derived View** dialog appears.
  </Step>

  <Step>
    Enter a name for the derived view in the **View Name** field. This is the name that appears in the list of saved derived views.
  </Step>

  <Step>
    Click **Confirm** to save the derived view.
  </Step>
</Steps>

### Access a Derived View in Integrations

When issuing queries to a derived view from within an integration tool, set the Connection or Database value to *CData*. The following syntax shows the correct fully-qualified syntax for accessing a derived view:

```sql theme={null}
SELECT * FROM [CData].[DerivedViews].[SampleDerivedView]
```

Substitute the name of your derived view for the \[SampleDerivedView] value in the example above.

### Access a Derived View in Data Explorer

After you create a derived view, it appears in the list of derived views in Data Explorer. You can click the three dots next to the entry in the list to open a list of options.

<Frame>
  <img alt="Query derived view" />
</Frame>

* Select **Open/Edit** to open the derived view in the query editor and edit the view.
* Select **Delete** to remove the derived view from the list.
* Select **Query** to execute the query. The contents of the derived view appear in the Data Explorer query view, and you can then click **Execute** to view the query results.
* Select **Add to Workspace** to add the derived view to a workspace. An **Add to Workspace** dialog appears to select the workspace.

### Modify a Derived View

To modify the query of a derived view, use one of the methods outlined above to access it. With the derived view open, modify the text in the query field as needed and click **Save Changes** at the top of the Data Explorer.

To rename a derived view, click the three dots next to the entry in the list and select **Rename**. Enter the new name in the dialog that appears and click **Confirm**.

### Delete a Derived View

To delete a derived view, click the three dots next to the entry in the list and select **Delete**. In the confirmation dialog that appears, click **Delete** again.

<Note>
  Deleting a derived view does not affect data in the source.
</Note>

## Create Scheduled Queries

You can save a query as a scheduled query. A scheduled query runs at user-defined intervals.

To create a scheduled query:

<Steps>
  <Step>
    Create your query using the Query Builder or the SQL Editor.
  </Step>

  <Step>
    Click **Save** > **Save as Scheduled Query**.
  </Step>

  <Step>
    You then enter the details about the scheduled query, such as how often it runs. See [Scheduled Queries](/en/Scheduled-Queries) for details.
  </Step>
</Steps>

## Add to a Workspace

You can use the Data Explorer to add assets to a workspace.

<Steps>
  <Step>
    Click the table or view you want to add to a workspace. Connect AI calls contents of a workspace *assets*.
  </Step>

  <Step>
    Click the three dots next to the asset and select **Add to Workspace**.
  </Step>

  <Step>
    Select the workspace to move the asset to and click **Confirm**.
  </Step>
</Steps>

## Add a Cache Job

You can use the Data Explorer to cache the data for a table or view. Caching allows you to fetch cached data from a database instead of retrieving live data, improving performance. See [Caching](/en/Caching) for details.

To add a cache job:

<Steps>
  <Step>
    Click the table or view you want to cache.
  </Step>

  <Step>
    Click the three dots next to the asset and select **Add Cache Job**. You are redirected to the **Edit Job** page.
  </Step>

  <Step>
    Follow the instructions in [Edit a Cache Job](/en/Caching#edit-a-cache-job).
  </Step>
</Steps>


# Data Security
Source: https://docs.cloud.cdata.com/en/Data-Security

The ***Data Security*** page enables you to add and configure preset and custom security rules.

<Note>Interested in getting early access to the Data Security feature? Contact [support@cdata.com](mailto:support@cdata.com).</Note>

The Data Security feature lets you detect and control sensitive data as it moves into and out of Connect AI. You define security rules that identify sensitive values, such as credit card numbers or personal identifiers, and choose how to handle each match: take no action, raise a warning, redact the value, or block it. You can also apply different actions to inbound and outbound data.

In Connect AI, **inbound** data is the content of the queries and requests you submit, and **outbound** data is the content Connect AI returns in the query results. Each rule can apply a different action to each direction.

Use preset rules for common, built-in data types, or create custom rules that match your own patterns with a regular expression.

Access **Data Security** by selecting **Manage > Data Security** in the Connect AI navigation menu.

<Frame>
  <img alt="Main Data Security page" />
</Frame>

The **Data Security** main page contains the following information about each security rule:

* **Rule Name**–the name of the preset category, or in the case of custom rules, the user-defined name of the rule. This column also displays a short description of the rule and its regulation/region tag(s). The regulation tags indicate the compliance regulations it helps address (for example, **CCPA / CPRA**, **GLBA**, **PCI DSS**, and **HIPAA**). The region tags indicate where the regulation applies (for example, **Global** and **US**).
* **Detection Method**–how the rule identifies a match. Preset rules use **Pattern match** (a built-in pattern for a known data type), while custom rules use **Regex**, where you provide your own regular expression and optionally a confidence score.
* **Inbound Rule**–the action applied to matching data coming into the system.
  * **None**–takes no action on matching data. The rule still detects the match, but the data passes through unchanged.
  * **Warn**–passes the matching data through unchanged, exactly as **None** does, but records the match in the logs for review.
  * **Redact**–masks or removes the matching sensitive values before the data enters the system, while allowing the rest of the data through.
  * **Block**–prevents data containing a match from entering the system.
* **Outbound Rule**–the same actions applied to matching data leaving the system: **None**, **Warn**, **Redact**, or **Block**.
* **Status**–whether the rule is **Enabled** or **Disabled**.
* **Rule Actions**–the icons in the last column represent the various actions you can perform on a security rule.
  * **Edit (🖉)**–edit the selected security rule (custom rules only).
  * **Delete (🗙)**–delete the selected security rule.

<Note>
  **How Redact and Block behave:** When you apply **Redact**, each matching value is replaced in place while the rest of the data is returned unchanged. On outbound data, text, numeric, and date values are redacted. Text values are redacted to XXXX, numeric values are redacted to 0, and date values are redacted to 1900-01-01. When there is a date in a varchar type column and a redact rule is set, the date is converted to a redacted datetime format (1900-01-01) rather than a redacted text format (XXXX).

  When you apply **Block**, a match stops the operation. An inbound match halts the query and returns an error to the caller, and an outbound match prevents the matching results from being returned.
</Note>

## Filtering

The section above the Rules table allows you to filter by rule name, regulation type, and/or region.

Use the **Regulation Type** and **Region** filters to filter by specific tags.

## Add a Rule

You can add a rule from preset categories, or add a custom rule.

### Add a Preset Rule

To add a preset rule:

<Steps>
  <Step>
    On the main **Data Security** page, click **Add**. The **Add Rule** dialog appears.
  </Step>

  <Step>
    Click **Preset Categories**.
  </Step>

  <Step>
    Either click a preset rule type (such as PCI DSS) or click **I don't know my type — show me all**, then click **Next**.
  </Step>

  <Step>
    Search by **Name**, **Regulation Type**, or **Region** for the rule. Select one or more rules to add. Select the checkbox next to **Entity** to select all.

    <Frame>
      <img alt="Add preset rule" />
    </Frame>
  </Step>

  <Step>
    Click **Confirm**.
  </Step>

  <Step>
    The rules are added as **Enabled**. Configure each rule by setting its **Inbound Rule** and **Outbound Rule**. To hold a rule before using it, toggle **Enabled** off.
  </Step>

  <Step>
    Click **Save Changes** to save the added rules.
  </Step>
</Steps>

### Add a Custom Rule

To add a custom rule:

<Steps>
  <Step>
    On the main **Data Security** page, click **Add**. The **Add Rule** dialog appears.
  </Step>

  <Step>
    Click **Custom Rule**.
  </Step>

  <Step>
    In the **Add Rule** dialog, enter the following:

    * **Rule Name**–the user-defined name of the rule.
    * **Regex Pattern**–the regular expression used to identify a match for this rule. For example, to validate a US ZIP code, matching both five-digit and nine-digit formats, would be `^\d{5}(?:-\d{4})?$`.
    * **Score**–(optional) the confidence score, between 0.0 and 1.0, that determines how the rule evaluates a regex match. At 0.8 or above, the pattern match alone is sufficient to trigger the rule. Below 0.8, the rule triggers only when context keywords are also found in the data. A **Score** below 0.8 requires one or more **Context Keywords** to be present in the data.
    * **Context Keywords**–case-insensitive keywords that help refine detection and reduce false positives. The system looks for context keywords in the table name, column name, column label, or cell of the table. In the ZIP code example, you can add context keywords such as *zip\_code*, *zip code*, and *zipcode* to ensure you are redacting a ZIP code and not another type of code. Required when **Score** is below 0.8; optional when **Score** is 0.8 or above, as the pattern match alone is sufficient. If context keywords are provided, a **Score** must also be set.
    * **Inbound Detection**–the action applied to matching data coming into the system: **None**, **Warn**, **Redact**, or **Block**.
    * **Outbound Detection**–the same actions applied to matching data leaving the system: **None**, **Warn**, **Redact**, or **Block**.

    <Frame>
      <img alt="Add custom rule" />
    </Frame>
  </Step>

  <Step>
    Click **Confirm**.
  </Step>

  <Step>
    The rule is added as **Enabled**. To hold a rule before using it, toggle **Enabled** off.
  </Step>

  <Step>
    You can edit the **Inbound Rule**, **Outbound Rule**, and **Status** on the main page. To edit the **Rule Name**, **Regex Pattern**, **Score**, or **Context Keywords**, click the **Edit (🖉)** button.
  </Step>

  <Step>
    Click **Save Changes** to save the rules on the **Data Security** page.
  </Step>
</Steps>


# Azure Analysis Services
Source: https://docs.cloud.cdata.com/en/Data-Sources/AAS



## Setup Guide

Follow these steps to connect Azure Analysis Services to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Analysis Services* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **URL** field, enter the URL of the Azure server instance. For example, `asazure://eastus.asazure.windows.net/serverCode`.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id found on the Overview page of the OAuth app used to authenticate to Microsoft SharePoint on Azure.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Azure Analysis Services sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Azure Analysis Services account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Azure Password">
    <Steps>
      <Step>
        In **User** enter the Azure Analysis Services username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id found on the Overview page of the OAuth app used to authenticate to Microsoft SharePoint on Azure.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** that you will use to access data.
      </Step>

      <Step>
        Enter your **OAuth Client Id**.
      </Step>

      <Step>
        Enter your **OAuth JWT Cert** OR your **OAuth Client Secret**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Analysis Services, see [this information page](https://cdn.cdata.com/help/OAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure Data Lake Storage
Source: https://docs.cloud.cdata.com/en/Data-Sources/ADLS



## Setup Guide

Follow these steps to connect Azure Data Lake Storage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Data Lake Storage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Account** name for your Azure Data Lake Storage account.
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant**: either the domain name (for example, *contoso.onmicrosoft.com*) or the directory (tenant) ID.
      </Step>

      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Azure Data Lake Storage sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Azure account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant**: either the domain name (for example, *contoso.onmicrosoft.com*) or the directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned to your OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your OAuth application.
      </Step>

      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **Azure Tenant**: either the domain name (for example, *contoso.onmicrosoft.com*) or the directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned to your OAuth application.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert**: the certificate content for your client certificate.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type** that matches your certificate store format.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Password** if the certificate store is password-protected.
      </Step>

      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Managed Identity">
    <Steps>
      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Access Key">
    <Steps>
      <Step>
        Enter the **Access Key** for your Azure Data Lake Storage account.
      </Step>

      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SAS">
    <Steps>
      <Step>
        Enter the **Shared Access Signature** for your Azure Data Lake Storage account.
      </Step>

      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Data Lake Storage, see [this information page](https://cdn.cdata.com/help/HDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure Data Lake Storage (Legacy)
Source: https://docs.cloud.cdata.com/en/Data-Sources/ADLSSync



## Prerequisites

#### Whitelist CData IPs

To establish a connection to Azure Data Lake Storage, you need to allow access to Azure Data Lake Storage via CData’s IP. When hosting Azure Data Lake Storage behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure Azure Data Lake Storage Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

#### If Connect AI Is Configured to Run in the Same Region as Azure Data Lake Storage

If you have a firewall enabled and Connect AI is running in the same region as Azure Data Lake Storage, you need to configure virtual network rules and add Connect AI virtual network subnets to the list of allowed virtual networks. See Microsoft’s [documentation](https://learn.microsoft.com/en-us/azure/storage/common/storage-network-security?tabs=azure-portal#grant-access-from-a-virtual-network) for details. Contact [CData support](https://www.cdata.com/support/submit.aspx) if you need a list of region-specific fully qualified subnet IDs.

## Setup Guide

Follow these steps to connect Azure Data Lake Storage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Data Lake Storage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **File Format**—choose the file format type.
    * **Auth Scheme**—set to **Azure AD** (Entra ID).
    * **Azure Storage Account**—the name of the storage account.
    * **File System**(Optional)—enter the file system protocol.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Azure Data Lake Storage sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Azure Data Lake Storage account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Azure Data Lake Storage, see [this information page](https://cdn.cdata.com/help/HDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# ADP
Source: https://docs.cloud.cdata.com/en/Data-Sources/ADP



## Prerequisites

Before you can establish a connection with ADP, go to ADP’s [API Central documentation](https://developers.adp.com/guides/quick-start-guides/adp-api-central-for-clients/api-guides/api-central-quick-start-guide) to learn how to obtain the necessary credentials.

The following is an overview of the steps:

<Steps>
  <Step>
    Create a new project and add a use case and name.
  </Step>

  <Step>
    Click **View project** and copy the client Id and client secret.
  </Step>

  <Step>
    Generate an SSL security certificate for your project, which contains a private key. Copy and securely save the private key for authenticating to the ADP API.
  </Step>

  <Step>
    ADP masks all sensitive personal information by default. Ask an ADP administrator to update this for API access if needed.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect ADP to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *ADP* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information in Connect AI:

    * **OAuth Client Id**—the client Id that you copied in the prerequisites.
    * **OAuth Client Secret**—the client secret that you copied in the prerequisites.
    * **SSL Client Cert**—First, paste the entire private key that you copied in ADP API Central. The private key begins with `---BEGIN PRIVATE KEY---` and ends with `---END PRIVATE KEY---`.
      Then, open the .pem file you downloaded from ADP API Central. The .pem file contains the public certificate. Copy and paste the contents of the .pem file after the private key information. The public certificate begins with `---BEGIN CERTIFICATE---` and ends with `---END CERTIFICATE---`.
      <Note>If you followed the manual process to use a PFX certificate instead of PEM, you must use a password-protected PFX. You also need to change the **SSL Client Cert Type** setting to **PFXBLOB** in the **Advanced Settings** tab of this screen.</Note>
    * **SSL Client Cert Password**—(optional) the password for the Client Cert, if it is encrypted. If it is not password-protected, leave this field blank.
  </Step>

  <Step>
    Set the **Use UAT** field according to your ADP configuration.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and ADP, see [this information page](https://cdn.cdata.com/help/JDJ/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# API
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIConnector

The Connect AI API Connector provides a fully customizable way to connect directly to a REST API. You can connect to proprietary endpoints, filter relevant columns, run queries, and manage user access right from your Connect AI account.

Follow these steps to connect your API:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type `API` in the search field, then click the datasource name.
  </Step>

  <Step>
    Connect and configure your REST API. The following tabs are available. Start with the global settings, then continue to create tables and set permissions. Click the links below to view detailed documentation.

    * [Global Settings](/en/Data-Sources/APIGlobalSettings)—set global connection properties, authentication, headers, and pagination.
    * [Private Cloud Connector](/en/Private-Cloud-Connector)—if you are using the API in a Private Cloud Connector on-premises network, [register the gateway](/en/Private-Cloud-Connector#register-the-private-cloud-connector-in-connect-ai) in this tab. You must then [install the on-premises gateway](/en/Private-Cloud-Connector#deploy-the-private-cloud-connector-with-docker). Finally, in **Global Settings**, change the **Connection Type** to **Private Cloud Connector** and finish the Private Cloud Connector setup.
    * [Tables](/en/Data-Sources/APICreateTable)—create tables, configure properties and filter columns.
    * [Permissions](/en/Data-Sources/APIPermissions)—manage user access.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Tables
Source: https://docs.cloud.cdata.com/en/Data-Sources/APICreateTable



## Summary

After connecting to your API, you can create, view, and configure the data from it in the form of tables. Tables can be customized via a wizard. You can also specify server-side filters to improve efficiency. This page covers creating tables and configuring table data, parameters, headers, and filters.

## Create Tables

When creating tables for [API Connector](/en/Data-Sources/APIConnector), it is important to remember that each table must be created individually in order to be listed in the Connector's catalog. To do so, follow the steps below:

<Steps>
  <Step>
    Click **Add** to begin creating a new table.
  </Step>

  <Step>
    Enter a **Name** for the table.
  </Step>

  <Step>
    In **Request URL**, choose either `Get` or `Post`.
  </Step>

  <Step>
    Enter the URL of your API endpoint into the **Request URL** field.
    <Note>To connect to an API that requires a different request for each record, include the name of the column in curly braces. For example, `https://api.example.com/table/{id}`.</Note>
  </Step>

  <Step>
    If you select `Post`, supply the **Body** to include in the API request. Then enter the `URL` of your API endpoint.

    <p>
      You can use the **Body** section to request body filters for `Post` API requests. The following is an example of a request body and a filter:

      ```
      {
      	"query": { "date_utc": { "$gte": "[_input.startDate]", "$lte": "[_input.endDate]" } }, "options": { "select": \["name", "date_utc", "success", "details"], "sort": { "date_utc": "asc" }, "limit": 20 } 
      }
      ```
    </p>

    In this case, the user is prompted to input a start date and an end date.

    <p>
      When you have a body filter, **Edit Table** displays the message **Body Filter(s) Detected**.
    </p>

    <Note>
      If your table request body also contains filters, you need to add an escape character to the square bracket, as shown in the example above before `"name"`.
    </Note>
  </Step>

  <Step>
    Select a **Response Type** of **JSON**, **LDJSON**, **XML**, or **CSV**.

    * **JSON**—the response is formatted as JSON.
    * **LDJSON**—the response is formatted as Linked Data JSON, which allows you to link definitions of objects within the JSON data.
    * **XML**—the response is formatted as XML-tagged data.
    * **CSV**—the response is formatted as comma-delimited data.
  </Step>
</Steps>

### Table Data

Next, you must tell the connector how to model the API's response into a table.

<Steps>
  <Step>
    Click **Configure** in the **Table Data** section to open the configuration wizard.
  </Step>

  <Step>
    (Optional) If you added a unique record identifier in the **Request URL**, such as `{id}`, a **Query Inputs** dialog appears. Set a value for the record identifier in order to retrieve the initial response data, and click **Next**.

    <Frame>
      <img alt="API query inputs" />
    </Frame>
  </Step>

  <Step>
    Connect AI calls your API and provides a preview of the data.

    <Frame>
      <img alt="API Connector Table" />
    </Frame>
  </Step>

  <Step>
    Click **Next**.
  </Step>

  <Step>
    In the **Add Repeat Elements** dialog, select the checkbox next to the repeat elements you want added to your API table. This is the path of the element in your API endpoint which contains the repeating items to be used as rows. You can select multiple repeat elements if there are repeat elements within multiple paths in the response.

    <Frame>
      <img alt="API add repeat elements" />
    </Frame>
  </Step>

  <Step>
    (Optional) You can toggle **Custom Repeat Elements** to add repeat elements manually, rather than selecting from a list.

    <Frame>
      <img alt="API custom repeat elements" />
    </Frame>

    Click **Add Repeat Element** to add another repeat element manually.
  </Step>

  <Step>
    Click **Next**.
  </Step>

  <Step>
    In the **Add Columns** dialog, select the columns to add to your API table.

    <Frame>
      <img alt="API add columns" />
    </Frame>

    Once you have selected your columns, click **Next**.
  </Step>

  <Step>
    In the **Preview Table** dialog, review the table contents. Click **Back** to make any changes.

    <Frame>
      <img alt="API preview table" />
    </Frame>
  </Step>

  <Step>
    Review the preview of your table and click **Next**. The Configuration Wizard automatically imports all selected columns into the correct fields.
  </Step>

  <Step>
    Back in the **Table Data** section of the **Edit Table** screen, you can edit column names and data types. You can also assign primary keys or delete columns. In the case of child tables, you can also change the parent reference column. For other edits, click **Configure** again to adjust repeat elements and other data.
  </Step>

  <Step>
    In the **Pseudo Columns** tab, you can add columns to be used as filters in the WHERE clause of queries, but are not present in the data output.
  </Step>

  <Step>
    Click **Save** at the top of **Edit Table** screen to save the table data.
  </Step>

  <Step>
    Click **Preview** at the top of the **Edit Table** screen to preview your table. If you added a unique record identifier, a **Query Inputs** dialog appears. Set a value to preview the response data.
  </Step>
</Steps>

### Parameters

You can add URL parameters to be sent with all API requests for this table. To create a parameter:

<Steps>
  <Step>
    Click **Add Param**.
  </Step>

  <Step>
    Enter the parameter **Name**.
  </Step>

  <Step>
    Enter the parameter **Value**.
  </Step>
</Steps>

To add more parameters, repeat the steps above.

### Headers

You can add HTTP headers that are sent with all API requests for this table. These headers are in addition to the headers configured with the API connector itself. To add a new header:

<Steps>
  <Step>
    Enter the header **Name**.
  </Step>

  <Step>
    Specify the **Value** of the header.
  </Step>
</Steps>

To add more headers, click **Add Header** and repeat the steps above.

### Filters

After creating the table with columns, you can create filters to define the behavior of the API Connector when a WHERE clause is issued during a query. Filters are optional, but can improve performance for WHERE clause conditions.

<Steps>
  <Step>
    Click **Add Filter**.
  </Step>

  <Step>
    Select the **Column Name** the filter applies to. This filter is applied when the selected column and SQL operator exist in the WHERE clause.
  </Step>

  <Step>
    Select an **SQL Operator**. This filter is applied when the selected column and SQL operator exist in the WHERE clause.
  </Step>

  <Step>
    Select a **Request Filter** from the drop-down list: **URL Parameter** or **Request Header**. The request filter determines how the filter is passed in the request to the API.
  </Step>

  <Step>
    Specify the **URL Parameter** or the **Request Header** that this API uses to filter.
  </Step>
</Steps>

To add more filters, repeat the steps above.

#### Example

This example shows how to create a filter that processes a query that filters records in the Reports table by the date the record was created.

Here is an example of such a query:

```sql theme={null}
SELECT * FROM Reports Where CreatedDate > 2022-12-31
```

If no filter has been defined for this table, the connector processes this filter in memory by reading all of the rows from the API and filtering the list in memory by the specified `CreatedDate` column. However, this API supports this type of filtering on the server side which can improve performance substantially. This is what this query would look like to the API:

```bash theme={null}
https://www.mycustomapi.org/api/reports?$startdate=2022-12-31
```

In order to tell the connector how to send this filter to the API, you would specify the following fields:

**Column Name**: CreatedDate

**SQL Operator**: Greater Than

**Request Filter**: URL Parameter

**Parameter Name**: startdate

This instructs the connector that when a greater than operator has been specified for the `CreatedDate` column, include the `startDate` URL parameter with the filter value in the API request.

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Example API
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIExample



## Summary

This page acts as an example of the steps required to configure a connection to an API from start to finish. This example uses an API that contains people’s maintenance schedules for their vehicles.

## Create the API Connection

First, create a new API connection.

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    In the **Add Connection** dialog that opens, type *API* to display the API connector tile, then click the tile.
  </Step>

  <Step>
    On the **Global Settings Tab**, name the connection. This example uses "TestAPI."
  </Step>

  <Step>
    Select the Authentication method. Since no authentication is required for this API, select `No Auth`.
  </Step>

  <Step>
    Leave this section blank, because no headers are required for this connection.
  </Step>

  <Step>
    Set the pagination. This API uses a next page URL, providing the next page URL as part of the response. The following example shows the relevant part of the response from the Vehicles endpoint:

    ```json theme={null}
    {
      "people": [
        {
            ...
        },
        ...
      ],
      "nextLink": "https://my_vehicles/api?$skiptoken='ERNSH'"
    }
    ```
  </Step>

  <Step>
    Set the Pagination **Type** to `URL`.
  </Step>

  <Step>
    Set the URL Path to `/nextLink`.
  </Step>

  <Step>
    Click the **Create** button at the top of the page to save the API connection.
  </Step>
</Steps>

## Create the Table

Now that you've added a connection corresponding to a catalog, you can create tables for each of the API's endpoints.

<Steps>
  <Step>
    In your API connection, click **Tables** to open the Tables tab.
  </Step>

  <Step>
    Click **Add** to add a new table.
  </Step>

  <Step>
    Provide a **Name** for your table. This is the name that the table displays when accessing it from clients. For example: `Vehicles`.
  </Step>

  <Step>
    Leave the **Response Type** as `JSON` and the **Request** call as `GET`.
  </Step>

  <Step>
    Set the **Request URL** to your API endpoint URL. This example uses `https://my_vehicles/api`.
  </Step>

  <Step>
    Leave the **Parameters** section blank, since there are none for this API.
  </Step>

  <Step>
    Similarly, leave **Headers** blank.
  </Step>

  <Step>
    In the **Table Data** section, click **Configure** to automatically fill out the **Table Data** information. This opens the **Preview Request**, which shows the following API response:

    ```json expandable theme={null}
    {
      "people": [
        {
          "personal": {
            "age": 21,
            "gender": "M",
            "name": {
              "first": "John",
              "last": "Doe"
            }
          },
          "vehicles": [
            {
              "type": "car",
              "model": "Honda Civic",
              "insurance": {
                "company": "ABC Insurance",
                "policy_num": "12345"
              },
              "features": [
                "sunroof",
                "rims"
              ],
              "maintenance": [
                {
                  "date": "07-17-2017",
                  "desc": "oil change"
                },
                {
                  "date": "01-03-2018",
                  "desc": "new tires"
                }
              ]
            },
            {
              "type": "truck",
              "model": "Dodge Ram",
              "insurance": {
                "company": "ABC Insurance",
                "policy_num": "12345"
              },
              "features": [
                "lift kit",
                "tow package"
              ],
              "maintenance": [
                {
                  "date": "08-27-2017",
                  "desc": "new tires"
                },
                {
                  "date": "01-08-2018",
                  "desc": "oil change"
                }
              ]
            }
          ]
        },
        ...
      ]
    }
    ```
  </Step>

  <Step>
    Click **Next** to access the Add Columns menu. Here, you need to select a root path, and any columns to expose.
    The **Root Path** is the JSON element that contains repeating sub-elements and determines the rows of the table. In this case, you need to select multiple root paths because multiple elements repeat in this document. Because the root elements are nested, some data repeats for each row, as shown in this example. Select the `people` element first, because it repeats for each person, as shown in the following snippet from the response:

    ```json theme={null}
    {
         "people": [
             {
             <Person 1 data>
             },
             {
             <Person 2 data>
             }, 
             ...
         ]
     }
    ```

    Also select the `vehicles` and `maintenance` elements, because data from those two repeated sections is also needed.
    *Note: The JSON array uses square brackets `[]` to contain an array of JSON objects which are each contained within angle brackets `{}`.*
  </Step>

  <Step>
    For this example, select `first`, `last` from the people array, `type`, `model` from the vehicles array, and `date`, `description` from the maintenance array as the columns to expose.
  </Step>

  <Step>
    Click **Next** to access the **Table Preview**. This renders the first 10 rows of the table as currently configured. If configured correctly, you should see data for each column selected:

    | first | last | type | model | date | description |
    | :- | :- | :- | :- | :- | :- |
    | John | Doe | car | Honda Civic | 07-17-2017 | oil change |
    | John | Doe | car | Honda Civic | 01-03-2018 | new tires |
    | John | Doe | truck | Dodge Ram | 08-27-2017 | new tires |
    | John | Doe | truck | Dodge Ram | 01-08-2018 | oil change |
  </Step>

  <Step>
    Click **Confirm** to automatically add your **Table Data** configuration. The data selected should be reflected in the **Root Path** and **Columns** fields in the **Table Data** section.
  </Step>

  <Step>
    Click **Save** to save this table.
  </Step>
</Steps>

## Test Queries

After configuring your connection and your table, you can test it by running queries in the **Data Explorer**.

<Steps>
  <Step>
    In Connect AI, navigate to **Data Explorer**.
  </Step>

  <Step>
    In the **Connections** list, select the `TestAPI` connection created earlier. This expands all of that connection's tables, including the `Vehicles` table created in this example.
  </Step>

  <Step>
    Click the ellipsis next to this table and select **query**. This automatically generates the SQL query to retrieve all vehicles:

    * `SELECT * FROM [TestAPI].[REST].[Vehicles]` You can modify this SQL query as needed. For example, you can add a `WHERE` clause to select only vehicles of a specific model:
    * `SELECT * FROM [TestAPI].[REST].[Vehicles] WHERE model='Honda Civic'`
  </Step>

  <Step>
    Click **Execute** to run this query. If everything is configured correctly, the results are visible immediately.
  </Step>
</Steps>

To connect to this API data from your preferred client, refer to the details documented for the specific client on the **Integrations** page. To access this data, you might need to set the catalog (or database, depending on the client) to `TestAPI`.

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Global Settings
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIGlobalSettings



## Summary

Global settings apply to all the tables that can be discovered through an API connection. This page covers the configuration of authentication, headers, and pagination. Once these are set, you can continue to the **Tables** tab and create [Tables](/en/Data-Sources/APICreateTable).

## Connection Type

You can select a **Direct** or a **Private Cloud Connector** connection. If you select **Direct**, continue to **Authentication**. If you are setting up a Private Cloud Connector on-premises connection, see [Private Cloud Connector](/en/Private-Cloud-Connector) for more information.

## Authentication

By default, an API connector is set to **No Auth**. If your API requires authentication, select the appropriate method and follow the instructions in the relevant tab below. If no authentication is required, click **Save Changes** to save the connector. Afterwards, configure any required Headers and the Pagination type before creating tables.

<Note>
  The authentication method you choose applies to every table added to this connector.
</Note>

<Tabs>
  <Tab title="No Auth">
    No additional settings are required for this authentication method.

    <Steps>
      <Step>
        At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic Auth">
    <Steps>
      <Step>
        In the **User** field, enter the API username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
      </Step>
    </Steps>
  </Tab>

  <Tab title="Digest Auth">
    <Steps>
      <Step>
        In the **User** field, enter the API username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth 1.0">
    <Steps>
      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter your **OAuth Request Token URL** to retrieve request tokens from.
      </Step>

      <Step>
        Enter your **OAuth Authorization URL** so request tokens can be authorized on sign in.

        <Warning>
          The **OAuth Authorization URL** is a direct browser redirect. It does not route through Private Cloud Connector. This URL must be reachable from the end user's browser. URLs that resolve to a private or link-local IP address (such as `10.x.x.x`, `192.168.x.x`, or `169.254.x.x`) are rejected when saving the connection.
        </Warning>
      </Step>

      <Step>
        Enter your **OAuth Access Token URL** so authorized request tokens can be exchanged for access tokens.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the API provider's sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your API provider and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth 2.0">
    <Steps>
      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter your **OAuth Authorization URL** so users can be authorized on sign in.

        <Warning>
          The **OAuth Authorization URL** is a direct browser redirect. It does not route through Private Cloud Connector. This URL must be reachable from the end user's browser. URLs that resolve to a private or link-local IP address (such as `10.x.x.x`, `192.168.x.x`, or `169.254.x.x`) are rejected when saving the connection.
        </Warning>
      </Step>

      <Step>
        Enter your **OAuth Access Token URL** so authorization tokens can be exchanged for access tokens.
      </Step>

      <Step>
        Enter your **OAuth Refresh Token URL** so refresh tokens can be exchanged for access tokens when old access tokens expire.
      </Step>

      <Step>
        Select the **OAuth Client Authentication Mode**: **Send as Basic Auth header** or **Send in Post body**. Select the authentication mode that the API provider's documentation recommends. The default value is **Send as Basic Auth header**.
      </Step>

      <Step>
        Enter the **Header Prefix**. The header prefix is incorporated into the Authorization header before the token. The default value is `Bearer`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the API provider's sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your API provider and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
      </Step>
    </Steps>

    #### OAuth 2.0 Custom Parameters

    To add custom parameters to associated requests in OAuth 2.0, do the following:

    <Steps>
      <Step>
        Enter the parameter name in the **Name** field.
      </Step>

      <Step>
        Enter the value of the parameter in the **Value** field.
      </Step>
    </Steps>

    To add more parameters, click **Add Parameter** and repeat the above steps as required.
  </Tab>

  <Tab title="OAuth Client">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter your **OAuth Access Token URL** so authorization tokens can be exchanged for access tokens.
      </Step>

      <Step>
        (Optional) Enter **OAuth Scopes**. These scopes tell the access token what it is permitted to do. Check your API provider's documentation for the scopes it supports.
      </Step>

      <Step>
        Select the **OAuth Client Authentication Mode**: **Send as Basic Auth header** or **Send in Post body**. Select the authentication mode that the API provider's documentation recommends. The default value is **Send as Basic Auth header**.
      </Step>

      <Step>
        Enter the **Header Prefix**. The header prefix is incorporated into the Authorization header before the token. The default value is `Bearer`.
      </Step>

      <Step>
        At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
      </Step>
    </Steps>

    #### OAuth Client Custom Parameters

    To add custom parameters to OAuth Client token requests, do the following:

    <Steps>
      <Step>
        Enter the parameter name in the **Name** field.
      </Step>

      <Step>
        Enter the value of the parameter in the **Value** field.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth Password">
    <Steps>
      <Step>
        In the **User** field, enter the API username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter your **OAuth Access Token URL** so authorization tokens can be exchanged for access tokens.
      </Step>

      <Step>
        (Optional) Enter **OAuth Scopes**. These scopes tell the access token what it is permitted to do. Check your API provider's documentation for the scopes it supports.
      </Step>

      <Step>
        Select the **OAuth Client Authentication Mode**: **Send as Basic Auth header** or **Send in Post body**. Select the authentication mode that the API provider's documentation recommends. The default value is **Send as Basic Auth header**.
      </Step>

      <Step>
        Enter the **Header Prefix**. The header prefix is incorporated into the Authorization header before the token. The default value is `Bearer`.
      </Step>

      <Step>
        At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
      </Step>
    </Steps>

    #### OAuth Password Custom Parameters

    To add custom parameters to associated requests in OAuth Password, do the following:

    <Steps>
      <Step>
        Enter the parameter name in the **Name** field.
      </Step>

      <Step>
        Enter the value of the parameter in the **Value** field.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Bearer Token">
    <Steps>
      <Step>
        Enter the **Bearer Token** obtained from your API provider. The bearer token can be obtained from the provider's developer portal, from a command-line tool, or through other means. Refer to your provider's documentation.
      </Step>

      <Step>
        At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
      </Step>
    </Steps>
  </Tab>

  <Tab title="API Key">
    <Steps>
      <Step>
        Select the **API Key Type**: **Header** or **Query Parameter**. The key type depends on the API provider. See the provider's API reference for details.
      </Step>

      <Step>
        Enter the **API Key Name**. This is the name of the key that you created in your API provider (usually in the provider's developer portal).
      </Step>

      <Step>
        Enter the **API Key Value**. This value is the key itself; keep it confidential.
      </Step>

      <Step>
        At the top of the Connect AI **Add API Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable).
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Headers

To add HTTP headers that are sent with all API calls, do the following:

<Steps>
  <Step>
    Enter the header name in the **Name** field.
  </Step>

  <Step>
    Specify the value of the header in the **Value** field.
  </Step>
</Steps>

To add more headers, click **Add Header** and repeat the above steps as required.

## Pagination

You can specify the pagination **Type** to use with the API Connector. First, select the Pagination type. The options available are:

### None

Any API request returns the full dataset in one response.

### Offset

When using offset paging, Connect AI defines the page size and the number of records to skip when retrieving subsequent pages. For offset paging, set the following values:

* **Offset Param**: The name of the URL parameter defining the API offset in the API request.
* **Page Size Param** (Optional): The name of the URL parameter defining how many records to retrieve per page.
* **Page Size**: The number of records to retrieve per page. The connector uses this value to calculate the offset. Set this to the default page size of the API you are connecting to.

#### Example

In the request below, the user has set **Offset Param** to "pageOffset", **Page Size Param** to "pageSize", and **Page Size** to 1000. This example is showing the request for page 6 of data because the connector automatically increments the offset.

```bash theme={null}
https://myapi?pageOffset=5000&pageSize=1000
```

### Number

When using page numbers to control paging, set the following values:

* **Page Number Param**: The name of the URL parameter defining the page number.
* **Page Size Param** (Optional): The name of the URL parameter that defines the page size.
* **Page Size** (Optional): The number of records to retrieve per page.

#### Example

In the request below, the user has set **Page Number Param** to "pageNum", **Page Size Param** to "pageSize", and **Page Size** to 1000. This example is showing the request for page 6 of data because the connector automatically increments the page.

```bash theme={null}
https://myapi?pageNum=6&pageSize=1000
```

### Token

When using next page token to control paging, set the following values. The connector automatically includes the token in each request from the previous response.

* **Token Path**: The path in the API response defining the next page token.
* **Has More Path** (Optional): The path in the API response defining whether there are more records available.
* **Token Source**: Select whether the token should be sent in the request as a `URL Parameter` or in the `Request Body`.
* **URL Parameter**: The name of the URL parameter to pass the paging token.
* **Request Body**: The path in the request body where to pass the paging token.

#### Example using Parameters

In the request below, the user has set **URL Parameter** to “pageToken” and **Token Path** to “/results/nextpagetoken”.

**Request:**

```bash theme={null}
https://myapi?pageToken=123456
```

**Response:**

```json theme={null}
{
  "results": [
    {
      "rows": [
        {
          "id": "123",
          "name": "Acme",
          "country": "United States",
          "no_employees": 500
        },
        ...
      ],
      "nextpagetoken": 123457
    }
  ]
}
```

#### Example using Body

In the request below, the user has set **Request Body** to “/request/pageToken”, **Token Path** to “/results/nextpagetoken”, and **Has More Path** to “/results/morePages”.

**Request Body:**

```json theme={null}
{
  "request": [
    {
      "country": "United States",
      "pageToken": 123456
    }
  ]
}
```

**Response:**

```json theme={null}
{
  "results": [
    {
      "rows": [
        {
          "id": "123",
          "name": "Acme",
          "country": "United States",
          "no_employees": 500
        },
        ...
      ],
      "nextpagetoken": 123457,
      "morePages": true
    }
  ]
}
```

### URL

When using next page URLs to control paging, you first need to select where the URL for the next page is in the response:

* **Response Type**: Select either `Response Body` if the URL is in the body of the response, or `Response Header` if the URL is in a header of the response.
* **Response Body**: The path in the API response defining the next page URL. This value should be supplied in XPath notation. See the example below.
* **Response Header**: If the next page URL is passed in the response headers with a “Link” header, set this to specify the header name.

#### Example using Path

In the example below, the user has set **Response Body** to “/results/nextpageurl”. Here is an example response which contains the next page URL:

**Response:**

```json theme={null}
{
  "results": [
    {
      "rows": [
        {
          "id": "123",
          "name": "Acme",
          "country": "United States",
          "no_employees": 500
        },
        ...
      ],
      "nextpageurl": "https://myapi?nextpage=81a3ebdb-1483-45cd-84d1-f711d1308698"
    }
  ]
}
```

## Advanced

The **Verbosity** field should be left at `2` unless required for troubleshooting purposes.

After creating an API connection, proceed to creating [Tables](/en/Data-Sources/APICreateTable).

You can add **Retry Status Codes** to retry the request if the API call fails with that status code.

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# AWeber
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-AWeber



## Prerequisites

Before you can add the connection, you must register an OAuth application with AWeber:

<Steps>
  <Step>
    Create a free AWeber developer account at [https://labs.aweber.com](https://labs.aweber.com).
  </Step>

  <Step>
    Log in to your developer account and create an app.
  </Step>

  <Step>
    After creating the app, copy the assigned **Client ID** and **Client Secret**. Store the client secret securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect AWeber to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *AWeber* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the AWeber developer portal.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the AWeber sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your AWeber account and grant the requested permissions.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# AfterShip
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Aftership



## Prerequisites

Before you can add the connection, you must generate an API key from your AfterShip account:

<Steps>
  <Step>
    Log in to the AfterShip Account Portal and navigate to **Settings** > **API Keys** in the dashboard side menu.
  </Step>

  <Step>
    Click **Create API Key**, enter a name or description for the key, then choose your preferred signature header and configure admin API permissions.
  </Step>

  <Step>
    Click **Save** to generate the key.
  </Step>

  <Step>
    Copy the key immediately and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect AfterShip to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *AfterShip* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** from your AfterShip account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# AgileCRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-AgileCRM



## Prerequisites

Before you can add the connection, you must obtain your REST API Key from your AgileCRM account:

<Steps>
  <Step>
    Log in to your AgileCRM account and go to **Admin Settings** > **API & Analytics**.
  </Step>

  <Step>
    Copy the **API Key** listed under **API Key for REST Clients**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect AgileCRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *AgileCRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain**, which is the subdomain of your AgileCRM account URL. For example, if your AgileCRM URL is *[https://yourcompany.agilecrm.com](https://yourcompany.agilecrm.com)*, the **Domain** is *yourcompany*.
  </Step>

  <Step>
    Set the **User** to your AgileCRM login email address.
  </Step>

  <Step>
    Set the **Password** to the REST API Key that you obtained in the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Aha!
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Aha



## Prerequisites

Before you can use OAuth authentication, you must register an OAuth application in your Aha! account:

<Steps>
  <Step>
    Log in to your Aha! account and go to **Settings** > **Personal** > **Developer** > **OAuth Applications**.
  </Step>

  <Step>
    Enter a name for your application and set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Save**. Make note of the **Client ID** and **Client Secret**. Copy and store them securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Aha! to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Aha!* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain** for your Aha! account. For example, if your Aha! URL is *[https://yourcompany.aha.io](https://yourcompany.aha.io)*, enter *yourcompany*.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Aha!.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Aha! sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Aha! account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apify
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Apify



## Prerequisites

Before you can add the connection, you must retrieve your API token from the Apify Console:

<Steps>
  <Step>
    Log in to the Apify Console and navigate to **Settings**.
  </Step>

  <Step>
    Generate a new API token and copy it. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Apify to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apify* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apollo
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Apollo



## Prerequisites

Before you can add the connection, you need to register an OAuth application with Apollo:

<Steps>
  <Step>
    Log in to your Apollo account and go to **Settings** > **Integrations**.
  </Step>

  <Step>
    Locate the **API** option and click **Connect**.
  </Step>

  <Step>
    Click **OAuth registration** to open the registration form.
  </Step>

  <Step>
    Complete the required fields:

    * **App Name**–the name of your app or product.
    * **App Logo**–(optional) an image to display in the authorization prompt.
    * **OAuth Redirect URL**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
    * **Scopes**–select the permissions your app needs. Apollo automatically includes `read_user_profile` and `app_scopes`.
  </Step>

  <Step>
    Click **Submit** to register the app.
  </Step>
</Steps>

After registration, Apollo displays the **Client Id** and **Client Secret**. Make note of these values, since the Client Secret is only shown once.

## Setup Guide

Follow these steps to connect Apollo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apollo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Connect AI, enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Apollo.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Apollo sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Apollo account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Attio
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Attio



## Prerequisites

Before you can add the connection, you must obtain an API key from your Attio account settings.

## Setup Guide

Follow these steps to connect Attio to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Attio* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from Attio.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Avaza
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Avaza



## Prerequisites

Before you can add the connection, you must register an OAuth application with Avaza:

<Steps>
  <Step>
    Sign in to your [Avaza account](https://app.avaza.com) and go to **Settings** > **Manage Developer Apps** > **OAuth 2 Apps**.
  </Step>

  <Step>
    Click **Add OAuth App** and complete the required fields:

    * **Application Name**–the name of your application.
    * **Redirect URI**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save the application. Make note of the **Client ID** and **Client Secret**. In Connect AI, the Client ID is entered as the **OAuth Client Id** and the Client Secret as the **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Avaza to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Avaza* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Avaza.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Avaza sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Avaza account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# BambooHR
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-BambooHR



## Prerequisites

Before you can add the connection, you need to generate an API key from your BambooHR account:

<Steps>
  <Step>
    Log in to BambooHR with a user that has sufficient permissions. The API key inherits the permissions of the user who creates it, so for full employee access, have an admin generate the key.
  </Step>

  <Step>
    Click your name in the lower-left corner of any page and select **API Keys** from the user context menu.
  </Step>

  <Step>
    Click **Add API Key**, give the key a name, and generate it.
  </Step>

  <Step>
    Copy the key immediately and store it securely. BambooHR only displays the key once.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect BambooHR to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *BambooHR* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Connect AI, enter the **Domain**, which is the subdomain of your BambooHR account URL (for example, if your BambooHR URL is *[https://yourcompany.bamboohr.com](https://yourcompany.bamboohr.com)*, the Domain is *yourcompany*).
  </Step>

  <Step>
    Enter the **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bannerbear
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Bannerbear



## Prerequisites

Before you can add the connection, you must obtain an API key from your Bannerbear account. Bannerbear supports two key types:

* **Project key**: Scoped to a single project. Found in the project's **Settings** page.
* **Master key**: Provides access across all projects. Found in **Account Settings** under **API Key**.

Copy the key and store it securely.

## Setup Guide

Follow these steps to connect Bannerbear to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bannerbear* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    Set **Key Type** to **Project** or **Master**, depending on the key you are using.
  </Step>

  <Step>
    If you are using a Master key, enter the **Project Id** of the target project.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Benchmark Email
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-BenchmarkEmail



## Prerequisites

Before you can add the connection, you must obtain an API key from your Benchmark Email account:

<Steps>
  <Step>
    Log in to the Benchmark Email Portal and click your username in the top-right corner of the dashboard.
  </Step>

  <Step>
    Select **Integrations** from the drop-down menu.
  </Step>

  <Step>
    Click **API Key** in the left-hand menu.
  </Step>

  <Step>
    Generate a new key or copy your existing key, then store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Benchmark Email to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Benchmark Email* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your Benchmark Email account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bitly
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Bitly



## Prerequisites

Before you can add the connection, you must generate an access token from your Bitly account:

<Steps>
  <Step>
    Log in to your Bitly account at [https://bitly.com](https://bitly.com) and navigate to **Settings**, then **Developer Settings**.
  </Step>

  <Step>
    Click **Generate Access Token**. Copy the token. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Bitly to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bitly* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bright Data
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-BrightData



## Prerequisites

Before you can add the connection, you must obtain an API key from your Bright Data account:

<Steps>
  <Step>
    Log in to the Bright Data Control Panel and navigate to **Account Settings** > **API**.
  </Step>

  <Step>
    Generate or copy your API key and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Bright Data to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bright Data* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Bright Data account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Permissions
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIPermissions

The permissions settings provide a way to manage the access of different users to your connected API. The permissions tab contains an active list of users and their assigned capabilities.

Set permissions for each user by checking or unchecking the boxes next to their user name that aligns to the following privileges:

* **Select** data from the API’s database.
* **Insert** data into the API’s database.
* **Update** data in the API’s database.
* **Delete** data from the API’s database.
* **Execute** functions on the API’s database.

To save your changes before navigating away, click the **Save Changes** button on the top right.

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Act! CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/ActCRM



## Setup Guide

Follow these steps to connect Act! CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Act! CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Choose an **Act Edition** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Act CRM">
    <Steps>
      <Step>
        Enter the following information:

        * **Password**—the user password
        * **User**—the Act! CRM username for authentication
        * **URL**—the URL of the Act! CRM account
        * **Act Database**—the Act! database to which you want to connect
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Act Premium Cloud">
    <Steps>
      <Step>
        Enter the following information:

        * **Act Cloud Name**—the handle assigned to the Act! Premium Cloud account. You can find this in your web browser's address field when you open your Act! account. The form is similar to `https://eup1-iis-04.eu.hosted.act.com/**ActCloudName**`. Enter only the Act cloud name, not the entire URL.
        * **Password**—the user password
        * **User**—the Act! CRM username for authentication
        * **URL**—the URL of the Act! CRM account
        * **Act Database**—the Act! database to which you want to connect
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Act! CRM, see [this information page](https://cdn.cdata.com/help/FTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Act-On
Source: https://docs.cloud.cdata.com/en/Data-Sources/ActOn



## Setup Guide

Follow these steps to connect Act-On to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Act-On* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Act-On sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Act-On account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Act-On, see [this information page](https://cdn.cdata.com/help/OVM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# ActiveCampaign
Source: https://docs.cloud.cdata.com/en/Data-Sources/ActiveCampaign



## Setup Guide

Follow these steps to connect ActiveCampaign to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *ActiveCampaign* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **API Key**—the API Key for your ActiveCampaign account. Find this in your account on the **Settings** page under the **Developer** tab. Each user in your ActiveCampaign account has their own unique API key.
    * **URL**—find this in your account on the **My Settings** page under the **Developer** tab. For example: `https://{yourAccountName}.api-us1.com`
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and ActiveCampaign, see [this information page](https://cdn.cdata.com/help/JUM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Active Directory
Source: https://docs.cloud.cdata.com/en/Data-Sources/ActiveDirectory



## Setup Guide

Follow these steps to connect Active Directory to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Active Directory* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the Active Directory server into the **Server** field.
  </Step>

  <Step>
    Enter the port for connecting to the Active Directory server in the **Port** field.
  </Step>

  <Step>
    Enter the Active Directory username for authentication into **User**.
  </Step>

  <Step>
    Enter the user password.
  </Step>

  <Step>
    Enter the **Base DN**. Specifying a narrow base distinguished name limits the scope of searches and can increase performance.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Active Directory, see [this information page](https://cdn.cdata.com/help/CDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Acumatica
Source: https://docs.cloud.cdata.com/en/Data-Sources/Acumatica



## Setup Guide

Follow these steps to connect Acumatica to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Acumatica* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the base **URL** of your Acumatica site.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Acumatica username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Select a **Schema**. By default, this is set to `REST` Contract-Based API. You can also select `OData` to use the OData API for Acumatica Generic Inquiries. See the [OData](/en/API/OData-Dashboard) page for more information.
      </Step>

      <Step>
        If using the `REST` API, enter your **Endpoint Name** and **Endpoint Version**. These values can be found under Endpoint Properties in the Web Services Endpoint form of your Acumatica ERP.
      </Step>

      <Step>
        If using the `Odata` API, enter your **Company** Name.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Acumatica account.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Acumatica account.
      </Step>

      <Step>
        Select a **Schema**. By default, this is set to `REST` Contract-Based API. You can also select `OData` to use the OData API for Acumatica Generic Inquiries.
      </Step>

      <Step>
        If using the `REST` API, enter your **Endpoint Name** and **Endpoint Version**. These values can be found under Endpoint Properties in the Web Services Endpoint form of your Acumatica ERP.
      </Step>

      <Step>
        If using the `Odata` API, enter your **Company** Name.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Acumatica sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Acumatica account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Acumatica, see [this information page](https://cdn.cdata.com/help/OIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Adobe Analytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/AdobeAnalytics



## Setup Guide

Follow these steps to connect Adobe Analytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Adobe Analytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        (Optional) Enter your **Global Company Id**. If left blank, the connection uses the first Company Id found.
      </Step>

      <Step>
        (Optional) Enter your Report Suite Id in the **RSID** field. To find your Report Suite Id, navigate to **Admin** > **Report Suites**. If left blank, the connection tries to detect it automatically.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Adobe Analytics sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Adobe Analytics account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Follow the steps below to create a custom app and obtain the connection properties to enter in this section.

        a. Navigate to the following URL: [https://console.adobe.io/home](https://console.adobe.io/home).

        b. Click the **Create new project** button.

        c. Select the **Add API** option.

        d. Select **Adobe Analytics**, click **Next**, and then select **OAuth** and then click **Next** again.

        e. Select the **Web** option and supply the URL of the page to redirect to (*[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*).

        f. Click **Save configured API**.

        Your client is now created. Note that your client has a Client ID (API Key) and a Client Secret. These are added in the next step.
      </Step>

      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your Adobe Analytics account for OAuth.
        * **OAuth Client Secret**—the client secret assigned when you registered your Adobe Analytics account for OAuth.
        * **Global Company Id**—(optional) your company identifier. If left blank, the connection uses the first Company Id found.
        * **RSID**—(optional) your report suite identifier. To find your RSID, navigate to **Admin** > **Report Suites**. If left blank, the connection tries to detect it automatically.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Adobe Analytics, see [this information page](https://cdn.cdata.com/help/SCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Adobe Commerce
Source: https://docs.cloud.cdata.com/en/Data-Sources/AdobeCommerce



## Setup Guide

Follow these steps to connect Adobe Commerce to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Adobe Commerce* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Adobe Commerce username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password (for basic authentication).
      </Step>

      <Step>
        Fill in the **URL** field with the HTTP or HTTPS endpoint of your Adobe Commerce system (for example, `https://magentohost`).
      </Step>

      <Step>
        (Optional) Enter the **Store Code** for the store to which you want to connect. You need to enter a code in this field when more than one store is present in your Adobe Commerce system.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the Adobe Commerce **Access token**. See the [Adobe documentation](https://developer.adobe.com/commerce/webapi/get-started/authentication/gs-authentication-token/) for more information.
      </Step>

      <Step>
        Fill in the **URL** field with the HTTP or HTTPS endpoint of your Adobe Commerce system (for example, `https://magentohost`).
      </Step>

      <Step>
        (Optional) Enter the **Store Code** for the store to which you want to connect. You need to enter a code in this field when more than one store is present in your Adobe Commerce system.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Adobe Commerce, see [this information page](https://cdn.cdata.com/help/BZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Adobe Experience Manager
Source: https://docs.cloud.cdata.com/en/Data-Sources/AdobeExperienceManager



## Setup Guide

Follow these steps to connect Adobe Experience Manager to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Adobe Experience Manager* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL**, which is the full WebDAV-enabled URL of your JCR Repository (for example, *[http://localhost:4503/crx/server](http://localhost:4503/crx/server)*).
  </Step>

  <Step>
    Enter your Adobe Experience Manager **User** and **Password**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>


# Adobe Target
Source: https://docs.cloud.cdata.com/en/Data-Sources/AdobeTarget



## Prerequisites

Before you can add the connection, you must create an OAuth app in the Adobe Developer Console to obtain a Client ID and Client Secret:

<Steps>
  <Step>
    Navigate to [https://developer.adobe.com/console](https://developer.adobe.com/console) and sign in.
  </Step>

  <Step>
    Click **Create new project**.
  </Step>

  <Step>
    Select **Add API**, choose **Adobe Target**, and click **Next**.
  </Step>

  <Step>
    Select **OAuth Server-to-Server** and click **Next**.
  </Step>

  <Step>
    Select one or more product profiles to configure permissions and click **Save configured API**.
  </Step>

  <Step>
    Copy the **Client ID (API Key)** and **Client Secret**. Store them securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Adobe Target to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Adobe Target* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **OAuth Client Id**–the Client ID from your Adobe Developer Console project.
    * **OAuth Client Secret**–the Client Secret from your Adobe Developer Console project.
    * **Tenant**–the tenant name for your organization's Adobe Experience Cloud workspace.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Airtable
Source: https://docs.cloud.cdata.com/en/Data-Sources/Airtable



## Setup Guide

Follow these steps to connect Airtable to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Airtable* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

By default, **Enable Metadata API** (in the **Advanced Settings** tab) is set to true. Enabling the Metadata API requires the 'schema.bases:read' scope for both PersonalAccessToken and OAuthPKCE authentication.

## Authentication Methods

<Tabs>
  <Tab title="PersonalAccessToken">
    <Steps>
      <Step>
        Enter the Airtable Personal Access Token in the **OAuth Access Token** field. To obtain the token, log in to your [Airtable user account](https://airtable.com/), navigate to the token creation page, and click **Create new token**. Add all the workspaces and bases that you want the token to have access to. Copy and save the generated token, as it will only be shown once.
      </Step>

      <Step>
        Enter your Airtable **Base Id**. The Base Id can be found in the [Airtable API Reference](https://airtable.com/api).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Enter your Airtable Base Id in the **Base Id** field. The Base Id can be found in the [Airtable API Reference](https://airtable.com/api).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Airtable, see [this information page](https://cdn.cdata.com/help/JAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# AlloyDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/AlloyDB



## Setup Guide

Follow these steps to connect AlloyDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *AlloyDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the AlloyDB server in the **Server** field.
  </Step>

  <Step>
    In the **User** field, enter the AlloyDB username for authentication.
  </Step>

  <Step>
    Enter the user password in the **Password** field.
  </Step>

  <Step>
    (Optional) In the **Database** field, enter the name of the AlloyDB database to connect to. If this is left blank, the user's default database is used.
  </Step>

  <Step>
    (Optional) Enter the port for connecting to the AlloyDB server into the **Port** field.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and AlloyDB, see [this information page](https://cdn.cdata.com/help/KYJ/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon Athena
Source: https://docs.cloud.cdata.com/en/Data-Sources/AmazonAthena



## Setup Guide

Follow these steps to connect Amazon Athena to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon Athena* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **S3 Staging Directory** that Amazon Athena uses to store the results of a query.
  </Step>

  <Step>
    Enter the Amazon Athena **Data Source**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSRootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        (Optional) Enter the **AWS External Id** only if emulating a different role.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        In **User** enter the Amazon Athena username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        In **User** enter the Amazon Athena username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL**.
      </Step>

      <Step>
        (Optional) Enter the **AWS Role ARN** only if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Amazon Athena account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Amazon Athena account for OAuth.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Amazon Athena sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Amazon Athena account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Amazon Athena, see [this information page](https://cdn.cdata.com/help/FKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon DynamoDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/AmazonDynamoDB



## Prerequisites

#### Whitelist CData IPs

To establish a connection to Amazon DynamoDB, you need to allow access to Amazon DynamoDB via CData’s IP. When hosting Amazon DynamoDB behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure Amazon DynamoDB Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect Amazon DynamoDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon DynamoDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL** to the URL use by the SSO provider.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        In Amazon DynamoDB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSRootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        In Amazon DynamoDB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        (Optional) Enter the **AWS External Id** only if emulating a different role.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        In Amazon DynamoDB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        In **User** enter the Amazon DynamoDB username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format ‘ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;’. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        In Amazon DynamoDB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        In **User** enter the Amazon DynamoDB username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format ‘ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;’. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL**.
      </Step>

      <Step>
        (Optional) Enter the **AWS Role ARN** only if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        In Amazon DynamoDB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Amazon DynamoDB, see [this information page](https://cdn.cdata.com/help/DDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon Marketplace
Source: https://docs.cloud.cdata.com/en/Data-Sources/AmazonMarketplace



## Setup Guide

Follow these steps to connect Amazon Marketplace to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon Marketplace* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Marketplace** region in which you are registered.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Amazon Marketplace sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Amazon Marketplace account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Amazon Marketplace, see [this information page](https://cdn.cdata.com/help/ONM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon S3
Source: https://docs.cloud.cdata.com/en/Data-Sources/AmazonS3



## Setup Guide

Follow these steps to connect Amazon S3 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon S3* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **AWS Region** that hosts your AWS account.
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Specify the **SSO Login URL** used by the identity provider.
      </Step>

      <Step>
        Enter the **SSO Properties** required to connect to the identity provider. Separate all property-value pairs with a semicolon.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSRootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** for your AWS account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Secret Key** for your AWS account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** for your AWS account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Secret Key** for your AWS account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the role to assume during authentication. To chain multiple roles, separate the ARNs with semicolons.
      </Step>

      <Step>
        (Optional) Enter the **AWS External Id** if you are assuming a role in another account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRolesAnywhere">
    <Steps>
      <Step>
        Enter the **AWS Role ARN** for the role to assume during authentication.
      </Step>

      <Step>
        Enter the **AWS Certificate**: either the absolute path to the certificate file or the certificate content in PEM format encoded in base64.
      </Step>

      <Step>
        Enter the **AWS Private Key**: either the absolute path to the private key file or the private key content in PEM format encoded in base64.
      </Step>

      <Step>
        Enter the **AWS Profile ARN** for the profile to pull policies from.
      </Step>

      <Step>
        Enter the **AWS Trust Anchor ARN** for the trust anchor to use for authentication.
      </Step>

      <Step>
        (Optional) Enter the **AWS Certificate Password** if your certificate is protected.
      </Step>

      <Step>
        (Optional) Enter the **AWS Private Key Password** if your private key is encrypted.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL** provided by Okta.
      </Step>

      <Step>
        Enter the **SSO Properties** required to connect to Okta. Separate all property-value pairs with a semicolon.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Keycloak">
    <Steps>
      <Step>
        Enter the **Keycloak Realm URL**: the full URL to your Keycloak server including the specific realm used for authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned to your OAuth application in Keycloak.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your OAuth application in Keycloak.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the PingFederate **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Specify the **SSO Login URL** used by the identity provider.
      </Step>

      <Step>
        Enter the **SSO Properties** required to connect to the identity provider. Separate all property-value pairs with a semicolon.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** used to consume the SAML response and exchange it for AWS credentials.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon S3 (Legacy)
Source: https://docs.cloud.cdata.com/en/Data-Sources/AmazonS3Sync



## Setup Guide

Follow these steps to connect Amazon S3 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon S3* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the Name of the bucket containing the CSV, Parquet, or Avro files you are connecting to.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Specify the **SSO Login URL** used by the SSO provider.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Select the **File Format** to use.
      </Step>

      <Step>
        In Amazon S3, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSRootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Select the **File Format** to use.
      </Step>

      <Step>
        In Amazon S3, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        (Optional) Enter the **AWS External Id** only if emulating a different role.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Select the **File Format** to use.
      </Step>

      <Step>
        In Amazon S3, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        In **User** enter the Amazon S3 username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Select the **File Format** to use.
      </Step>

      <Step>
        In Amazon S3, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        In **User** enter the Amazon S3 username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL**.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Select the **File Format** to use.
      </Step>

      <Step>
        In Amazon S3, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Amazon S3, see [this information page](https://cdn.cdata.com/help/SXH/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Anaplan
Source: https://docs.cloud.cdata.com/en/Data-Sources/Anaplan



## Prerequisites

Before connecting to Anaplan using the OAuth authentication method, you must create a custom OAuth application in Anaplan:

<Steps>
  <Step>
    Log in to Anaplan and navigate to **Home** > **Administration**.
  </Step>

  <Step>
    Click **OAuth Clients**.
  </Step>

  <Step>
    Click **New**.
  </Step>

  <Step>
    Enter a name for the OAuth client.
  </Step>

  <Step>
    Set the **Type** to **Authorization code grant**.
  </Step>

  <Step>
    Set the redirect URL to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Create client**.
  </Step>

  <Step>
    Note the **Client ID** and **Client Secret**. Use these values when configuring the connection in Connect AI.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Anaplan to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Anaplan* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Region** that corresponds to your Anaplan account's data hosting region.
  </Step>

  <Step>
    (Optional) Enter the **Catalog** to restrict the schema to only include objects from the specified catalog.
  </Step>

  <Step>
    (Optional) Enter the **Schema** to restrict the schema to only include objects from the specified schema.
  </Step>

  <Step>
    (Optional) Enter the **Bulk Timeout** to specify how long, in minutes, the provider waits for an Anaplan asynchronous job to complete before returning an error. The default value is 25 minutes.
  </Step>

  <Step>
    (Optional) Enter the **Bulk Polling Interval** to specify the maximum time interval, in milliseconds, between status checks for asynchronous jobs. The default value is 60000 milliseconds.
  </Step>

  <Step>
    (Optional) Enter the **Bulk Page Size** to specify the maximum number of records to process per page when reading asynchronous job results. The default value is 5000 records.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        For **OAuth Client Id**, enter the client ID from the prerequisites.
      </Step>

      <Step>
        For **OAuth Client Secret**, enter the client secret from the prerequisites.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User** (your Anaplan user email address).
      </Step>

      <Step>
        Enter the **Password** for your Anaplan account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Certificate">
    <Steps>
      <Step>
        Enter the **Certificate** in PEM format. This is the certificate used for certificate-based authentication.
      </Step>

      <Step>
        Set the **Certificate Type** to **PEM\_BLOB**.
      </Step>

      <Step>
        Enter the **Private Key** in PEM format. This is the private key associated with the certificate.
      </Step>

      <Step>
        Set the **Private Key Type** to **PEM\_BLOB**.
      </Step>

      <Step>
        (Optional) Enter the **Certificate Password** if the certificate is encrypted.
      </Step>

      <Step>
        (Optional) Enter the **Private Key Password** if the private key is encrypted.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache CouchDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApacheCouchDB



## Setup Guide

Follow these steps to connect Apache CouchDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache CouchDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** used to connect to Apache CouchDB (for example, *[http://localhost:5984](http://localhost:5984)*).
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    **Basic** authenticates with a CouchDB user name and password.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the authenticating user's user ID.
        * **Password**—the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="JWT">
    **JWT** authenticates by signing a JSON Web Token that CouchDB validates against its configured keys.

    <Steps>
      <Step>
        Enter the following information:

        * **JWT Subject**—the user subject for which the application is requesting delegated access.
        * **JWT Algorithm**—the encryption algorithm used for signing the JWT. Supported values are **RS256**, **RS384**, **RS512**, **ES256**, **ES384**, **ES512**, **HS256**, **HS384**, and **HS512**. The default value is **RS256**.
        * **JWT Key Type**—the type of the encryption key used for signing the JWT. Supported values are **PEMKEY\_BLOB** and **SYMMETRIC**. The default value is **PEMKEY\_BLOB**.
        * **JWT Key**—the encryption key for signing the JWT.
        * **JWT Expiration**—(optional) the amount of time until the JWT expires, in seconds.
        * **JWT Headers**—(optional) a collection of extra HTTP headers to include in the JWT header.
        * **JWT Claims**—(optional) a collection of extra claims to include in the JWT payload.
        * **Credentials Location**—(optional) the filepath of the settings file containing the JWT. If a settings file does not exist in this location, the provider creates a new settings file when it retrieves a JWT.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    **None** is when no authentication is required. Use this option when querying public CouchDB databases.

    <Steps>
      <Step>
        Enter the **Public Databases**, which is a comma-separated list of public databases to list as tables.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Apache CouchDB, see [this information page](https://cdn.cdata.com/help/JCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache HBase
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApacheHBase



## Setup Guide

Follow these steps to connect Apache HBase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache HBase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Server**—the host name, IP address, or URL of the server hosting Apache HBase. If there are multiple nodes, use the host name, IP address, or URL of the machine running the REST (Stargate) server.
    * **Port**—the port for the Apache HBase REST (Stargate) server. The default value is **8080**.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="None">
    **None** is when no authentication is required.

    <Steps>
      <Step>No additional settings are required for this authentication method.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    **Basic** is basic user name and password authentication.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the user who is authenticating to Apache HBase.
        * **Password**—the password used to authenticate to Apache HBase.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    If you set the **Auth Scheme** to **Negotiate**, the provider negotiates an authentication mechanism with the server. Use **Negotiate** if you want to use Kerberos for authentication.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the user who is authenticating to Apache HBase.
        * **Password**—the password used to authenticate to Apache HBase.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Apache HBase, see [this information page](https://cdn.cdata.com/help/RHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache Hive
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApacheHive



## Setup Guide

Follow these steps to connect Apache Hive to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache Hive* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Transport Mode** to use for communicating with the Hive server: **HTTP** or **BINARY**.
  </Step>

  <Step>
    For HTTP transport mode only, enter the **HTTP Path**, available in the 'hive.server2.thrift.http.path' property of your Hive configuration file (hive.site.xml).
  </Step>

  <Step>
    Select an **Auth Scheme** for use in connecting to Apache Hive. Select the option that matches the configuration of the HiveServer2. Follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Plain">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Apache Hive username for authentication.
        * **Password**—the user password.
        * **Port**—the port for connecting to the Apache Hive server. If using HTTP transport mode, set **Port** to the value in the 'hive.server2.thrift.http.port' property of the Hive configuration file (hive.site.xml).
        * **Server**—the host name or IP address of the server hosting HiveServer2.
        * **Database**—(optional) the Apache Hive database to use. If left empty, the connection uses the default Apache Hive database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Apache Hive, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>

  <Tab title="LDAP">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Apache Hive username for authentication.
        * **Password**—the user password.
        * **Port**—the port for connecting to the Apache Hive server. If using HTTP transport mode, set **Port** to the value in the 'hive.server2.thrift.http.port' property of the Hive configuration file (hive.site.xml).
        * **Server**—the host name or IP address of the server hosting HiveServer2.
        * **Database**—(optional) the Apache Hive database to use. If left empty, the connection uses the default Apache Hive database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Apache Hive, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Apache Hive, see [this information page](https://cdn.cdata.com/help/FIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache Impala
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApacheImpala



## Setup Guide

Follow these steps to connect Apache Impala to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache Impala* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Transport Mode** of **BINARY** or **HTTP**.
  </Step>

  <Step>
    Enter the following information:

    * **HTTP Path**—(HTTP transport mode only) the path component of the URL endpoint. The default value is "cliservice".
    * **User**—the Apache Impala username for authentication.
    * **Password**—the user password.
    * **Port**—the port for connecting to the Apache Impala server. For HTTP transport mode, this should be set to the value of the 'hs2\_http\_port' property of the Impala configuration (default: 28000).
    * **Server**—the name or network address of the SQL Server instance.
    * **Database**—(optional) the name of the Impala database to connect to. If not specified, the default database schema is used.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Apache Impala, see [this information page](https://cdn.cdata.com/help/GIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache Kafka
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApacheKafka



## Setup Guide

Follow these steps to connect Apache Kafka to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache Kafka* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Bootstrap Servers** that the provider uses to establish the initial connection to the Apache Kafka cluster.
  </Step>

  <Step>
    (Optional) Toggle on **Use SSL** to have the provider negotiate SSL/TLS when connecting to the Apache Kafka broker.
  </Step>

  <Step>
    Select the **Type Detection Scheme**, which specifies how the provider determines the available fields and data types for each topic. Then proceed to the relevant section below.
  </Step>
</Steps>

## Type Detection Scheme

<Tabs>
  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this type detection scheme.</Step>

      <Step>
        Select the **Auth Scheme** that the provider uses when connecting to the Apache Kafka broker, then proceed to the next section.
      </Step>
    </Steps>
  </Tab>

  <Tab title="RowScan">
    <Steps>
      <Step>No additional settings are required for this type detection scheme.</Step>

      <Step>
        Select the **Auth Scheme** that the provider uses when connecting to the Apache Kafka broker, then proceed to next section.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SchemaRegistry">
    <Steps>
      <Step>
        Enter the **Registry URL**, which is the endpoint of the schema registry. When this property is specified, the provider supports reading Avro and JSON schemas from the server.
      </Step>

      <Step>
        Select the **Registry Service** that the provider uses to retrieve key and value schemas for Apache Kafka topics. Options are **Confluent** and **AWSGlue**.
      </Step>

      <Step>
        Select the **Registry Auth Scheme** that the provider uses when connecting to the schema registry. Options are **None**, **Basic**, and **SSLCertificate**. If you select **Basic**, also enter the **Registry User** and **Registry Password** used to authenticate to the schema registry.
      </Step>

      <Step>
        (Optional) Select the **Schema Merge Mode**, which specifies how the provider exposes schemas with multiple versions. Options are **None** and **Simple**.
      </Step>

      <Step>
        (Optional) Select the **Non Registry Type Detection Scheme**, which specifies the type detection scheme to use for topics that do not have schemas in the schema registry. Options are **Disabled**, **None**, **RowScan**, and **MessageOnly**.
      </Step>

      <Step>
        Select the **Auth Scheme** that the provider uses when connecting to the Apache Kafka broker, then proceed to the next section.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SchemaRegistryAggregate">
    <Steps>
      <Step>
        (Optional) Select the **Non Registry Type Detection Scheme**, which specifies the type detection scheme to use for topics that do not have schemas in the schema registry. Options are **Disabled**, **None**, **RowScan**, and **MessageOnly**.
      </Step>

      <Step>
        Select the **Auth Scheme** that the provider uses when connecting to the Apache Kafka broker, then proceed to the [Authentication](#authentication) section.
      </Step>
    </Steps>
  </Tab>

  <Tab title="MessageOnly">
    <Steps>
      <Step>No additional settings are required for this type detection scheme.</Step>

      <Step>
        Select the **Auth Scheme** that the provider uses when connecting to the Apache Kafka broker, then proceed to the next section.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Authentication

<Tabs>
  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this authentication scheme.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Plain">
    <Steps>
      <Step>
        Enter the **User**, which is the username used to authenticate to the Apache Kafka broker.
      </Step>

      <Step>
        Enter the **Password** used to authenticate to Apache Kafka.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SCRAM">
    <Steps>
      <Step>
        Enter the **User**, which is the username used to authenticate to the Apache Kafka broker.
      </Step>

      <Step>
        Enter the **Password** used to authenticate to Apache Kafka.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SCRAM-SHA-512">
    <Steps>
      <Step>
        Enter the **User**, which is the username used to authenticate to the Apache Kafka broker.
      </Step>

      <Step>
        Enter the **Password** used to authenticate to Apache Kafka.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Kerberos">
    <Steps>
      <Step>
        Enter the **Kerberos SPN**, which is the full Kerberos service principal name (SPN) of the Apache Kafka broker.
      </Step>

      <Step>
        Enter the **Kerberos Service Name** used when authenticating to the Apache Kafka broker.
      </Step>

      <Step>
        (Optional) Enter the **Kerberos Keytab File**, which is the path to the keytab file that contains the Kerberos principals and encrypted keys used for authentication.
      </Step>

      <Step>
        (Optional) Toggle on **Use Kerberos Ticket Cache** to use the Kerberos ticket cache for authentication instead of a keytab file.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SSLCertificate">
    <Steps>
      <Step>
        Enter the **SSL Client Cert** used to authenticate with the Apache Kafka broker.
      </Step>

      <Step>
        Select the **SSL Client Cert Type**, which specifies the format of the SSL client certificate. Options are **JKSFILE**, **PFXFILE**, **PEMKEY\_FILE**, and **PEMKEY\_BLOB**.
      </Step>

      <Step>
        (Optional) Enter the **SSL Client Cert Password** used to decrypt the certificate provided in **SSL Client Cert**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="KafkaOAuthClient">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
      </Step>

      <Step>
        Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which identifies the Apache Kafka tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which identifies the Apache Kafka tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which identifies the Apache Kafka tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**, which identifies the type of key store containing the JWT certificate. Options are **PFXBLOB**, **JKSBLOB**, **PEMKEY\_BLOB**, **PUBLIC\_KEY\_BLOB**, **SSHPUBLIC\_KEY\_BLOB**, **XMLBLOB**, **BCFKSBLOB**, and **GOOGLEJSONBLOB**.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**, which identifies the type of key store containing the JWT certificate. Options are **PFXBLOB**, **JKSBLOB**, **PEMKEY\_BLOB**, **PUBLIC\_KEY\_BLOB**, **SSHPUBLIC\_KEY\_BLOB**, **XMLBLOB**, **BCFKSBLOB**, and **GOOGLEJSONBLOB**.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSWorkloadIdentity">
    <Steps>
      <Step>
        Enter the **AWS Workload Identity Config**, which are the configuration properties to provide when using Workload Identity Federation via AWS.
      </Step>

      <Step>
        Enter the **Workload Pool Id**, which is the ID of your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Project Id**, which is the ID of the Google Cloud project that hosts your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Provider Id**, which is the ID of your Workload Identity Federation pool provider.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureWorkloadIdentity">
    <Steps>
      <Step>
        Enter the **Azure Workload Identity Config**, which are the configuration properties to provide when using Workload Identity Federation via Azure.
      </Step>

      <Step>
        Enter the **Workload Pool Id**, which is the ID of your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Project Id**, which is the ID of the Google Cloud project that hosts your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Provider Id**, which is the ID of your Workload Identity Federation pool provider.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Apache Kafka, see [this information page](https://cdn.cdata.com/help/SKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache Phoenix
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApachePhoenix



## Setup Guide

Follow these steps to connect Apache Phoenix to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache Phoenix* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **URL**—the URL to your Apache Phoenix Query Server (PQS), for example *[http://phoenix-host:8765](http://phoenix-host:8765)*. When load balancing is configured, you can enter multiple URLs in a comma-separated list (for example, *URL1*, *URL2*, *URL3*).
    * **Version**—(optional) the version of the Apache Phoenix instance. The default value is **4.9.0**.
    * **Load Balance Strategy**—(optional) select the load balancing strategy used by the client-side load balancer (**None**, **Random**, **RoundRobin**, or **ShuffledRoundRobin**). The default value is **None**.
    * **Database Product Name**—(optional) select the name of the database product exposed by the Avatica server. The default value is **Auto** (the value is retrieved dynamically from the Avatica server).
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="None">
    **None** is when no authentication is required.

    <Steps>
      <Step>No additional settings are required for this authentication method.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    **Basic** is basic user name and password authentication.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Apache Phoenix user ID for authentication.
        * **Password**—the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    If you set the **Auth Scheme** to **Negotiate**, the provider negotiates an authentication mechanism with the server. Use **Negotiate** if you want to use Kerberos for authentication.

    <Steps>
      <Step>
        No additional settings are required for this authentication method.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureHDInsight">
    **AzureHDInsight** authenticates to an Apache Phoenix instance running on an Azure HDInsight cluster.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the HDInsight cluster username for authentication.
        * **Password**—the user password.
        * **Cluster Name**—the name of the cluster containing your Azure HDInsight instance.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Apache Phoenix, see [this information page](https://cdn.cdata.com/help/UAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Asana
Source: https://docs.cloud.cdata.com/en/Data-Sources/Asana



## Setup Guide

Follow these steps to connect Asana to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Asana* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Asana sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Asana account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Asana, see [this information page](https://cdn.cdata.com/help/UJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Authorize.net
Source: https://docs.cloud.cdata.com/en/Data-Sources/AuthorizeNet



## Setup Guide

Follow these steps to connect Authorize.net to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Authorize.net* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication

<Steps>
  <Step>
    Enter the **Login ID**, which is the Authorize.net API login Id associated with your payment gateway account.
    <Note>This value is not the same as the login Id that you use to log in to the Merchant Interface.</Note>
  </Step>

  <Step>
    Enter the **Transaction Key**, which is the Authorize.net transaction key associated with your payment gateway account.
  </Step>

  <Step>
    (Optional) Set **Use Sandbox** if you are using a Sandbox account. The provider makes requests to the production environment by default.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Authorize.net, see [this information page](https://cdn.cdata.com/help/CWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Avalara
Source: https://docs.cloud.cdata.com/en/Data-Sources/Avalara



## Setup Guide

Follow these steps to connect Avalara to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Avalara* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Avalara username for authentication into **User**.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="LicenseKey">
    <Steps>
      <Step>
        Enter the **Account Id** of your Avalara account. The Account Id is located in the upper-right corner of the Avalara admin console.
      </Step>

      <Step>
        Enter the **License Key** generated by an account administrator on the Avalara website. To generate a license key:

        a. Log in to Avalara as an account administrator.

        c. Select **Settings**.

        b. Select **Reset License Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Avalara, see [this information page](https://cdn.cdata.com/help/GEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Avro
Source: https://docs.cloud.cdata.com/en/Data-Sources/Avro



## Setup Guide

Follow these steps to connect Avro to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Avro* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI** for the Avro resource location.
  </Step>

  <Step>
    (Optional) Select the **Data Model** to use when parsing Avro documents. The default value is **None**.
  </Step>

  <Step>
    (Optional) Toggle **Aggregate Files** on if you want the provider to aggregate all the files in the URI directory into a single result.
  </Step>

  <Step>
    Select the **Connection Type**, which specifies the file storage service, server, or file access protocol through which your Avro files are stored and retrieved. Then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Connection Types

<Tabs>
  <Tab title="Amazon S3">
    <Steps>
      <Step>
        Select the **AWS Region** from the drop-down list. This is the hosting region for your Amazon Web Services.
      </Step>

      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme** to use when connecting to remote services. Then select the tab for your authentication scheme and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AwsRootKeys">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsEC2Roles">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsIAMRoles">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Role ARN**. This is the Amazon Resource Name of the role to use when authenticating.
          </Step>

          <Step>
            (Optional) Enter the **AWS External Id**. This is a unique identifier that might be required when you assume a role in another account.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsTempCredentials">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to AWS. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Session Token**. See the [AWS Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) for more information about the session token.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsCredentialsFile">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Keycloak">
        <Steps>
          <Step>
            Enter the **Keycloak Realm URL**. This specifies the full URL to the Keycloak server, including the specific realm used for authentication and authorization.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="EKSPodIdentity">
        <Steps>
          <Step>
            (Optional) Enter the **AWS Container Credentials Full URI**. This is the full URI of the container credential provider endpoint used by EKS Pod Identity.
          </Step>

          <Step>
            (Optional) Enter the **AWS Container Authorization Token File**. This is the path to a file containing the authorization token for the EKS Pod Identity credential provider.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Blob Storage">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2 SSL">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Files">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Box">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Dropbox">
    <Steps>
      <Step>
        (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTP">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTPS">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Google Cloud Storage">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Google Drive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS Secure">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTP">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTPS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="IBM Object Storage Source">
    <Steps>
      <Step>
        Enter the **Api Key** used to identify the user to the IBM Cloud.
      </Step>

      <Step>
        Enter the **Region**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from the security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneDrive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneLake">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Oracle Cloud Storage">
    <Steps>
      <Step>
        Enter the hosting **Region** for your S3-like Web Services.
      </Step>

      <Step>
        Enter the **Oracle Namespace**. This is the Oracle Cloud Object Storage namespace to use.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SFTP">
    <Steps>
      <Step>
        Select the **SSH Auth Mode**, which is the type of authentication to use when connecting to remote services. Then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Password">
        <Steps>
          <Step>
            Enter the **SSH User** used to authenticate to the SFTP server.
          </Step>

          <Step>
            Enter the **SSH Password** used to authenticate to the SFTP server.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Public_Key">
        <Steps>
          <Step>
            Enter the **SSH Client Cert**, which is the name of the certificate store for the client certificate.
          </Step>

          <Step>
            Select the **SSH Client Cert Type**, which is the type of key store containing the client certificate.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Password**. This is the password for the client certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Subject**. This is the subject of the SSH client certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint SOAP">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST V1">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure Data Catalog
Source: https://docs.cloud.cdata.com/en/Data-Sources/AzureDataCatalog



## Prerequisites

The **AzureServicePrincipal** and **AzureServicePrincipalCert** authentication methods require a custom OAuth application registered in Microsoft Entra ID (formerly Azure AD). If you are connecting with the **AzureAD** method, you can skip this section.

To create and register a custom OAuth application in Entra ID, follow these steps:

<Steps>
  <Step>
    Sign in to the Azure portal and navigate to **Microsoft Entra ID > App registrations**, then click **New registration**.
  </Step>

  <Step>
    Enter a **Name** for the application.
  </Step>

  <Step>
    Under supported account types, select **Any Microsoft Entra ID tenant - Multitenant**, then click **Register**.
  </Step>

  <Step>
    On the application's overview page, record the **Application (client) ID** and the **Directory (tenant) ID**. You enter these values as the **OAuth Client Id** and the **Azure Tenant** in the setup steps below.
  </Step>

  <Step>
    Open **Certificates & Secrets** and add the credential for your chosen method:

    * For the **AzureServicePrincipal** method, select **New client secret**, specify a duration, and click **Add**. Record the secret value (shown only once); you enter it as the **OAuth Client Secret**.
    * For the **AzureServicePrincipalCert** method, select **Upload certificate** and upload your client certificate.
  </Step>

  <Step>
    Open the **Authentication** tab and enable the **Access tokens** option.
  </Step>

  <Step>
    Open **API permissions** and add **Azure Data Catalog > Delegated permissions > user\_impersonation**. Save your changes, then grant admin consent if your organization requires it.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Azure Data Catalog to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Data Catalog* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) Enter the **Catalog Name** of the catalog to connect to. The default is *defaultcatalog*.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which is the Azure Data Catalog tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Azure Data Catalog sign-in page in a new tab.
      </Step>

      <Step>
        Sign in to your Azure Data Catalog account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which is the Azure Data Catalog tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter your **OAuth Client Id** (also known as the consumer key) assigned when you registered your custom OAuth application.
      </Step>

      <Step>
        Enter your **OAuth Client Secret** assigned when you registered your custom OAuth application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **OAuth JWT Cert**, the name of the client certificate's JWT Certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**, the type of key store that contains the JWT Certificate. The default is *PEMKEY\_BLOB*.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Password** if the certificate store requires it.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Subject**. This is the subject of the OAuth JWT certificate. Supports partial matches and the wildcard '\*' to select the first certificate. If omitted, the first certificate in the certificate store is used.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Data Catalog, see [this information page](https://cdn.cdata.com/help/GNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure DevOps
Source: https://docs.cloud.cdata.com/en/Data-Sources/AzureDevOps



## Setup Guide

Follow these steps to connect Azure DevOps to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure DevOps* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Organization** name. This is the segment of your Azure URL that follows the base URL, for example, [https://dev.azure.com/Organization\_Name](https://dev.azure.com/Organization_Name).
  </Step>

  <Step>
    Enter the **Catalog** to use.

    * If you want to query data for a specific project, set **Catalog** to either *Project\_projectId* or *Project\_projectName*. For example, to query data in a project named dev with the ID 2ee729d6-804d-4ece-84af-d5befa94abe8, you can set **Catalog** to either *Project\_dev* or *Project\_2ee729d6-804d-4ece-84af-d5befa94abe8*. To get a list of project IDs and names, execute a SELECT query against the Projects table.
    * Otherwise, enter *CData* to query information independent of a specific project.
  </Step>

  <Step>
    (Optional) Enter a **Schema**. If you are using the CData catalog, enter *Information* to access general Azure DevOps information not related to a specific project. Within any of the project catalogs, **Schema** can be set to *Project*, *Analytics*, or any of the repository schemas. To query data for a specific repository, set **Schema** to *Repository\_repositoryId*. Note that *Analytics* is read only.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Azure DevOps sign-in page in a new tab.
      </Step>

      <Step>
        Sign in to your Azure DevOps account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **Personal Access Token** generated in Azure DevOps.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure DevOps, see [this information page](https://cdn.cdata.com/help/HNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure Synapse
Source: https://docs.cloud.cdata.com/en/Data-Sources/AzureSynapse



## Setup Guide

Follow these steps to connect Azure Synapse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Synapse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        Enter the following information:

        * The **User** and **Password** for Azure Synapse.
        * **Port**—the port for connecting to the Azure Synapse server.
        * **Server**—the host name or IP address of the Azure Synapse server.
        * **Database**—(optional) the name of the Azure Synapse database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the following information:

        * **Port**—the port for connecting to the Azure Synapse server.
        * **Server**—the host name or IP address of the Azure Synapse server.
        * **Database**—(optional) the name of the Azure Synapse database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant that you use to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Azure Synapse account for OAuth.
        * Either the **OAuth Client Secret** for your Azure Synapse account for OAuth OR the **OAuth JWT Cert** multi-line key in PEM format. Follow the format shown.
        * **Port**—the port for connecting to the Azure Synapse server.
        * **Server**—the host name or IP address of the Azure Synapse server.
        * **Database**—(optional) the name of the Azure Synapse database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Synapse, see [this information page](https://cdn.cdata.com/help/HEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure Table Storage
Source: https://docs.cloud.cdata.com/en/Data-Sources/AzureTables



## Setup Guide

Follow these steps to connect Azure Table Storage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Table Storage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="SharedAccessSignature">
    <Steps>
      <Step>
        Enter the following information:

        * **Shared Access Signature**—a valid signature of a resource to connect to. This signature may be generated with a tool such as Azure Storage Explorer. See [Microsoft's help page](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview) for more information about shared access signatures.
        * **Account**—the Azure Storage account name. To access your Azure storage accounts or create one, log in to the Azure portal and click **Storage Accounts** in the services menu on the left. If the backend is set to **AzureStack**, set the Account as the complete host for your data. For example: `<account>.nm.azs.sandia.gov`. If the backend is set to **Emulator**, set the Account as the complete host. For example: `http://127.0.0.1:10002/devstoreaccount1`.
        * **Backend**—select the backend from the drop-down list. The backend is where the data is stored. Data may retrieved from the classic Azure Table Storage repository (**Storage**, the default), Azure Storage Emulator, CosmosDB, or Azure Stack Hub.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AccessKey">
    <Steps>
      <Step>
        Enter the following information:

        * **Account**—the Azure Storage account name. To access your Azure storage accounts or create one, log in to the Azure portal and click **Storage Accounts** in the services menu on the left. If the backend is set to **AzureStack**, set the Account as the complete host for your data. For example: `<account>.nm.azs.sandia.gov`. If the backend is set to **Emulator**, set the Account as the complete host. For example: `http://127.0.0.1:10002/devstoreaccount1`. To obtain the account name for the backend of **CosmosDB**, navigate to Cosmos DB service and select your Azure Cosmos DB Account. From the resource menu, go to the **Connection String** page. Find the account name and set the Account to this value.
        * **Access Key**—the key for the storage account. To obtain the Access Key for the default backend (**Storage**), log in to the Azure portal and click **Storage Accounts** in the services menu on the left to list the storage accounts. Select a storage account and click **Access Keys** in the **Settings** section. Either key1 or key2 can be used. To obtain the Access Key for the backend of **CosmosDB**, navigate to Cosmos DB service and select your Azure Cosmos DB Account. From the resource menu, go to the **Connection String** page. Find the PRIMARY KEY value and set the Access Key to this value.
        * **Backend**—select the backend from the drop-down list. Data may retrieved from the classic Azure Table Storage repository (**Storage**, the default), Azure Storage Emulator, CosmosDB, or Azure Stack Hub.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—(optional) the Microsoft Online tenant being used to access data. This value is the directory Id in **Azure Portal** > **Azure Active Directory** > **Properties**. If not specified, your default tenant is used.
        * **Account**—the Azure Storage account name. To access your Azure storage accounts or create one, log in to the Azure portal and click **Storage Accounts** in the services menu on the left. If the backend is set to **AzureStack**, set the Account as the complete host for your data. For example: `<account>.nm.azs.sandia.gov`. If the backend is set to **Emulator**, set the Account as the complete host. For example: `http://127.0.0.1:10002/devstoreaccount1`.
        * **Backend**—select the backend from the drop-down list. Data may retrieved from the classic Azure Table Storage repository (**Storage**, the default), Azure Storage Emulator, CosmosDB, or Azure Stack Hub.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Table Storage, see [this information page](https://cdn.cdata.com/help/CAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bcart
Source: https://docs.cloud.cdata.com/en/Data-Sources/BCart



## Setup Guide

Follow these steps to connect Bcart to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bcart* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Personal Access Token** from Bcart.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Bcart, see [this information page](https://cdn.cdata.com/help/KGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Backlog
Source: https://docs.cloud.cdata.com/en/Data-Sources/Backlog



## Setup Guide

Follow these steps to connect Backlog to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Backlog* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="APIToken">
    <Steps>
      <Step>
        Enter the following information:

        * **Api Key**—the API key that allows you to make requests to the Backlog API. You can generate this key by opening the Settings page in Backlog and selecting the **API** section.
        * **URL**—the URL of the Backlog account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the **OAuth Client Id** assigned when you registered your Backlog account for OAuth.
        * **OAuth Client Secret**—the client secret assigned when you register your Backlog account for OAuth.
        * **URL**—the URL of the Backlog account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Backlog, see [this information page](https://cdn.cdata.com/help/HOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Basecamp
Source: https://docs.cloud.cdata.com/en/Data-Sources/Basecamp



## Setup Guide

Follow these steps to connect Basecamp to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Basecamp* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Account Id** of the authenticated Basecamp user. Your Basecamp URL contains the Account Id immediately after `basecamp.com`.
  </Step>

  <Step>
    Select a Basecamp **Schema** to use. Select **V2**, the Basecamp 2 API, or **V3**, the Basecamp 3 API.

    <Note>
      The **Basic** authentication scheme is only available in the **V2** schema.
    </Note>
  </Step>

  <Step>
    (Optional) Enter the **Project Id** of the authenticated Basecamp user. By default, the Project Id is first one on the projects list.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Basecamp sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Basecamp account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Note>
      Basic authentication is only available when connecting to Basecamp V2.
    </Note>

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the username of the currently authenticated user.
        * **Password**—the password of the currently authenticated user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Basecamp, see [this information page](https://cdn.cdata.com/help/BCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# BigCommerce
Source: https://docs.cloud.cdata.com/en/Data-Sources/BigCommerce



## Setup Guide

Follow these steps to connect BigCommerce to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *BigCommerce* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your BigCommerce account for OAuth.
        * **OAuth Client Secret**—the client secret assigned when you registered your BigCommerce account for OAuth.
        * **Store Id**—this is located in the BigCommerce URL when you are logged in to your account. It is formatted as `https://store-[StoreId].mybigcommerce.com/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PersonalAccessToken">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Access Token**—To obtain the OAuth Access Token, log in to your BigCommerce account and do the following:
          1. Go to **Settings** > **Store-level API Tokens** > **+Create API Account**.
          2. Select **Token type** > **V2/V3 API Token**.
          3. Enter the name of your account (minimum of four characters).
          4. Choose the OAuth Scopes for the API Account you are creating. The driver cannot access data marked as "None" and cannot modify data marked as "read-only".
          5. Click **Save**. A successful save displays a pop-up window containing API credentials. Save your credentials, since you cannot return to this pop-up window.
        * **Store Id**—this is located in the BigCommerce URL when you are logged in to your account. It is formatted as `https://store-[StoreId].mybigcommerce.com/`. In BigCommerce, it is also known as the store hash.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and BigCommerce, see [this information page](https://cdn.cdata.com/help/UBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bing Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/BingAds



## Setup Guide

Follow these steps to connect Bing Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bing Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Customer Id**. You can find this Id by logging into your Bing Ads account and navigating to the **Accounts and Billing** settings page. Your customer Id also appears as the final number in the Bing Ads URL when you are logged in (for example, `azure.bingads.microsoft.com/cc/AccountDetails?cid=123456789`).
  </Step>

  <Step>
    Enter your **Developer Token**. To get the token, log in to the [Bing Ads Developer Portal](https://developers.ads.microsoft.com/Account) as a Microsoft Account user with the **Bing Ads Super Admin** role. Then, click **Request Token**.
  </Step>

  <Step>
    (Optional) Enter your **Account Id**. This can be found in your Bing Ads account by navigating to the **Accounts and Billing** settings page. Then, click **Your Account**. If not specified, the connection automatically queries the first account found.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Bing Ads sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Bing Ads account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Bing Ads, see [this information page](https://cdn.cdata.com/help/EZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bitbucket
Source: https://docs.cloud.cdata.com/en/Data-Sources/Bitbucket



## Prerequisites

Both the **OAuth** and **OAuthClient** authentication methods require a custom OAuth application (an OAuth consumer) created in Bitbucket.

To create an OAuth consumer, follow these steps:

<Steps>
  <Step>
    Sign in to Bitbucket and open the workspace you want to connect to.
  </Step>

  <Step>
    Navigate to **Settings > Workspace settings**, then under **Apps and features** select **OAuth consumers**.
  </Step>

  <Step>
    Click **Add consumer** and enter a **Name** for the consumer.
  </Step>

  <Step>
    In the **Callback URL** field, enter the Connect AI callback URL `https://oauth.cdata.com/oauth/`.
  </Step>

  <Step>
    Select the **Permissions** your application needs to access Bitbucket data.
  </Step>

  <Step>
    Save the consumer, then record the **Key** and **Secret**. You enter these values as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Bitbucket to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bitbucket* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) Enter the **Workspace**, the slug of the workspace to which to connect.
  </Step>

  <Step>
    (Optional) Enter the **Schema** to use. The available schemas are *Information*, the Repository schemas, and the Project schemas.
  </Step>

  <Step>
    (Optional) Enable **Include Deleted** to fetch deleted CommitComments and PullRequestComments records.
  </Step>

  <Step>
    Select your **Auth Scheme** and follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—Set to the Key (also known as the consumer key) assigned to your OAuth consumer.
        * **OAuth Client Secret**—Set to the Secret assigned to your OAuth consumer.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Bitbucket sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Bitbucket account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—Set to the Key (also known as the consumer key) assigned to your OAuth consumer.
        * **OAuth Client Secret**—Set to the Secret assigned to your OAuth consumer.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Box
Source: https://docs.cloud.cdata.com/en/Data-Sources/Box



## Prerequisites (OAuth JWT Authentication Only)

Before you can establish a connection with Box with OAuth JWT authentication, you must create a custom OAuth application in the Box Developer Console.

<Steps>
  <Step>
    Log in to the [Box Developer Console](https://app.box.com/developers/console).
  </Step>

  <Step>
    Click **Create New App**.
  </Step>

  <Step>
    Specify basic application information, as appropriate.
  </Step>

  <Step>
    In **OAuth 2.0 Redirect URI**, add *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)* as a redirect URI.
  </Step>

  <Step>
    Click **Create App**.
  </Step>

  <Step>
    After you have an administrator authorize the app, select the scope of user permissions your custom OAuth app can request.
  </Step>

  <Step>
    After your application is created and registered, click **Configuration** from the main menu to access your settings. Note the **Client Id** and **Client Secret**. You will need these values to configure the connection in Connect AI.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Box to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Box* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Box sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Box account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned to your custom OAuth application (obtained in the prerequisites).
        * **OAuth Client Secret**—the client secret assigned to your custom OAuth application (obtained in the prerequisites). This value is used to authenticate the application to the OAuth authorization server.
        * **OAuth JWT Subject Type**—the subject type for the JWT authentication. Select **enterprise** to authenticate as the enterprise (service account) or **user** to authenticate as a specific user. The default value is **enterprise**.
        * **OAuth JWT Public Key Id**—the Id of the public key registered with your Box app for JWT authentication.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the following information:

        * **Subject Id**—the Id of the user or enterprise on whose behalf the application is requesting delegated access.
        * **Subject Type**—The subject type for the client credentials authentication. Select **enterprise** to authenticate as the enterprise or **user** to authenticate as a specific user. The default value is **enterprise**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Box, see [this information page](https://cdn.cdata.com/help/BBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bullhorn CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/BullhornCRM



## Setup Guide

Follow these steps to connect Bullhorn CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bullhorn CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Data Center Code** where your account data is hosted. This code appears at the beginning of the Bullhorn CRM URL when you are logged in. For example, if your URL is `https://cls21.bullhornstaffing.com/BullhornSTAFFING/MainFrame.jsp`, your code is `CLS21`.
  </Step>

  <Step>
    Contact Bullhorn CRM to set up a custom OAuth application with the correct redirect URI for Connect AI, which is *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.

    <Note>
      Bullhorn CRM does not allow users to configure custom OAuth applications themselves. You must contact Bullhorn CRM for this step.
    </Note>
  </Step>

  <Step>
    After setting up your OAuth application, enter your **OAuth Client Id** and **OAuth Client Secret** in Connect AI.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Toggle **Include Custom Fields** on or off, depending on whether you want to include custom fields in the column listing.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Bullhorn CRM sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Bullhorn CRM account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the Bullhorn CRM username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Toggle **Include Custom Fields** on or off, depending on whether you want to include custom fields in the column listing.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Bullhorn CRM, see [this information page](https://cdn.cdata.com/help/HAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Business b-ridge
Source: https://docs.cloud.cdata.com/en/Data-Sources/Businessbridge



## Setup Guide

Follow these steps to connect Business b-ridge to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Business b-ridge* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the required fields for authentication: **Company Key**, **Subscription Key**, and **Project Key**. To obtain the subscription key, log in to the Business b-ridge API portal and select **Your name** > **Profile**. In the subscription section, click **Main Key**.
  </Step>

  <Step>
    Enter the URL of your Business b-ridge account (optional). The URL is in the following format: `https://{account}.azure-api.net`.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Business b-ridge, see [this information page](https://cdn.cdata.com/help/HBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# 1010data
Source: https://docs.cloud.cdata.com/en/Data-Sources/C1010



## Setup Guide

Follow these steps to connect 1010data to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *1010data* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Login URL** of your 1010data instance.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter your 1010data user ID in the **User** field.
      </Step>

      <Step>
        In **Password**, enter the user password.
      </Step>

      <Step>
        (Optional) Enter the **Group ID** of the SAM pool group to connect to, if using SAM pools.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        (Optional) Enter the **SSO Properties** with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="HTTPForm">
    <Steps>
      <Step>
        Enter your 1010data **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        (Optional) Enter the **SSO Properties** with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        (Optional) Enter the **SSO Properties** with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Blackbaud Financial Edge NXT
Source: https://docs.cloud.cdata.com/en/Data-Sources/FinancialEdgeNXT



## Prerequisites

Before you use the Blackbaud Financial Edge NXT connector, you must configure your own custom OAuth application via the Blackbaud SKY Developer Portal.

In your [SKY API Developer account](https://developer.blackbaud.com/):

<Steps>
  <Step>
    On the **My subscriptions** page, locate your subscription Id (primary access key).

    <Frame>
      <img alt="Blackbaud OAuth setup" />
    </Frame>
  </Step>

  <Step>
    On the **My applications** page, click **+New application** to configure a new OAuth application.
  </Step>

  <Step>
    In the **Add application** dialog, enter the information about the OAuth application as needed for your organization and click **Save**.

    <Frame>
      <img alt="Blackbaud add application" />
    </Frame>
  </Step>

  <Step>
    On the next page, do the following:

    * Add the CData redirect URI ([https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)).
    * Copy the OAuth **Client Id** and **Client Secret** to paste into Connect AI.
    * Edit **Scopes** to the desired level of data access.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Blackbaud Financial Edge NXT to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Blackbaud Financial Edge NXT* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Subscription Key**. Your subscription key can be found in your Blackbaud Financial Edge NXT profile.
  </Step>

  <Step>
    Paste the **Client Id** and **Client Secret** that you created in the prerequisites.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Blackbaud Financial Edge NXT sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Blackbaud Financial Edge NXT account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google BigQuery
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleBigQuery



## Prerequisites

In Google BigQuery, add the Connect AI static IP addresses to your connection whitelist.

## Setup Guide

Follow these steps to connect Google BigQuery to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google BigQuery* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Oauth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google BigQuery sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google BigQuery account.
      </Step>

      <Step>
        Click **Continue** to grant the requested permissions.

        <Note>
          Each permission is required for the connection to function.
        </Note>
      </Step>

      <Step>
        The **Project Id** field populates with your Google BigQuery project Ids. Select a project Id from the drop-down list or enter a custom value.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Oauth JWT">
    <Steps>
      <Step>
        In the **Project Id** field, enter the Google BigQuery project that you want to use.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert** provided by Google. This is a multi-line key.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Subject** if your services account is part of a GSuite domain and you want to enable delegation.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google BigQuery, see [this information page](https://cdn.cdata.com/help/DBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Blackbaud Raiser's Edge NXT
Source: https://docs.cloud.cdata.com/en/Data-Sources/RaiserEdgeNXT



## Prerequisites

Before you use the Blackbaud Raiser’s Edge NXT connector, you must configure your own custom OAuth application via the Blackbaud SKY Developer Portal.

In your [SKY API Developer account](https://developer.blackbaud.com/):

<Steps>
  <Step>
    On the **My subscriptions** page, locate your subscription Id (primary access key).

    <Frame>
      <img alt="Blackbaud OAuth setup" />
    </Frame>
  </Step>

  <Step>
    On the **My applications** page, click **+New application** to configure a new OAuth application.
  </Step>

  <Step>
    In the **Add application** dialog, enter the information about the OAuth application as needed for your organization and click **Save**.

    <Frame>
      <img alt="Blackbaud add application" />
    </Frame>
  </Step>

  <Step>
    On the next page, do the following:

    * Add the CData redirect URI ([https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)).
    * Copy the OAuth **Client Id** and **Client Secret** to paste into Connect AI.
    * Edit **Scopes** to the desired level of data access.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Blackbaud Raiser's Edge NXT to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Blackbaud Raiser's Edge NXT* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Subscription Key**. This key is found in your BlackBaud Raiser's Edge NXT Profile, after subscribing to SKY API Standard Edition.
  </Step>

  <Step>
    Paste the **Client Id** and **Client Secret** that you created in the prerequisites.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Blackbaud Raiser's Edge NXT sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Blackbaud Raiser's Edge NXT account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Blackbaud Raiser’s Edge NXT, see [this information page](https://cdn.cdata.com/help/JZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon Redshift
Source: https://docs.cloud.cdata.com/en/Data-Sources/Redshift



## Prerequisites

#### Whitelist CData IPs

To establish a connection to Amazon Redshift, you need to allow access to Amazon Redshift via CData’s IP. When hosting Amazon Redshift behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure Amazon Redshift Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect Amazon Redshift to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon Redshift* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the Amazon Redshift cluster into the **Server** field.
  </Step>

  <Step>
    Enter the Amazon Redshift **Database**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Amazon Redshift username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter the port for connecting to the Amazon Redshift server in the **Port** field.
      </Step>

      <Step>
        Enter the **AWS Principal ARN** to use during authentication if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        In Amazon Redshift, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the Amazon Redshift username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the port for connecting to the Amazon Redshift server in the **Port** field.
      </Step>

      <Step>
        Enter the **AWS Principal ARN** to use during authentication if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        In Amazon Redshift, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="IAMCredentials">
    <Steps>
      <Step>
        Enter the Amazon Redshift username for authentication in the **User** field.
      </Step>

      <Step>
        Enter your **AWS Access Key**.
      </Step>

      <Step>
        Enter your **AWS Secret Key**.
      </Step>

      <Step>
        Enter the port for connecting to the Amazon Redshift server in the **Port** field.
      </Step>

      <Step>
        Enter the **AWS Principal ARN** to use during authentication if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        In Amazon Redshift, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the Amazon Redshift username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL**.
      </Step>

      <Step>
        Enter the port for connecting to the Amazon Redshift server in the **Port** field.
      </Step>

      <Step>
        Enter the **AWS Principal ARN** to use during authentication if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        In Amazon Redshift, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the Amazon Redshift username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter the **OAuth Client Id** found in the Overview page of your Amazon Redshift application settings.
      </Step>

      <Step>
        Enter your **OAuth Client Secret**.
      </Step>

      <Step>
        Enter the **Scope**. For v1.0 OAuth tokens, this matches the **Scopes** field in the Expose of an API page of your OAuth app. For v2.0 OAuth tokens, it is the same as the app's Client Id.
      </Step>

      <Step>
        Enter the port for connecting to the Amazon Redshift server in the **Port** field.
      </Step>

      <Step>
        Enter the **AWS Principal ARN** to use during authentication if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Amazon Redshift sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Amazon Redshift account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        In Amazon Redshift, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Amazon Redshift, see [this information page](https://cdn.cdata.com/help/FRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Salesforce
Source: https://docs.cloud.cdata.com/en/Data-Sources/Salesforce



## Required Prerequisites (Salesforce Admin Only)

<Steps>
  <Step>
    In a separate tab or browser window, log in to Salesforce.
  </Step>

  <Step>
    In Connect AI, open the **Sources** page of the navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Salesforce* into the search field, then click the data source name.
  </Step>

  <Step>
    Click **Save & Test** to test the connection. This results in an error message, but is necessary so that the CData connector appears in Salesforce. Ignore the error message.
  </Step>

  <Step>
    Go back to your Salesforce application. In **Salesforce Setup** (gear icon), navigate to **Apps** > **Connected Apps** > **Connected Apps OAuth Usage**.
  </Step>

  <Step>
    For the CData Connector, click **Install**. Salesforce displays an installation page.
  </Step>

  <Step>
    Click **Install** again to complete the process.
  </Step>
</Steps>

## Setup Guide

Return to Connect AI to continue connecting Salesforce to your Connect AI account:

<Steps>
  <Step>
    On the **Basic Settings** tab of the Salesforce connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Salesforce sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Salesforce account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Salesforce username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter a security token. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the Salesforce username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT certificate**. This is multi-line and in PEM format.
      </Step>

      <Step>
        Select the **OAuth JWT Certification type**.
      </Step>

      <Step>
        Enter the **OAuth JWT Issuer**. This must include the client\_id or connected app for the which the certificate is registered.
      </Step>

      <Step>
        (Optional) Enter an **OAuth JWT Cert Password** if the certificate. This only needs to be done if the certificate is encrypted.
      </Step>

      <Step>
        (Optional) If required, add an **OAuth JWT Cert Subject**.
      </Step>

      <Step>
        (Optional) If implementing for an Experience Cloud Site, an **OAuth JWT Subject** is required. It must be formatted as an email.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OneLogin">
    <Steps>
      <Step>
        Enter the OneLogin **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the PingFederate **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Salesforce account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Salesforce account for OAuth.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Salesforce sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Salesforce account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Salesforce, see [this information page](https://cdn.cdata.com/help/RFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# au PAY Market
Source: https://docs.cloud.cdata.com/en/Data-Sources/auPAYMarket



## Setup Guide

Follow these steps to connect au PAY Market to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *au PAY Market* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **API Key**—the API key from your au PAY Market store account.
    * **Shop Id**—the store account ID of your au PAY Market store.
  </Step>

  <Step>
    Set the **Use Sandbox** field to **True** (if you are connecting to a test environment). Otherwise, leave it as **False**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and au PAY Market, see [this information page](https://cdn.cdata.com/help/SWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Integrations
Source: https://docs.cloud.cdata.com/en/Integrations

The ***Integrations*** page presents a list of available integration tools. Use the search field to find an integration tool by name. You can also use the **View** drop-down list to view the integration tools by category: **AI**, **BI and Reporting**, **ETL**, **No-Code/Low-Code**, **Dev**, and **iPaaS**. Each integration tool card contains a link to open its documentation in an embedded navigation pane. Where appropriate, cards also contain links to download connectors and view endpoint information.

<Frame>
  <img alt="Integrations" />
</Frame>

### AI Tools

Below is a list of the Artificial Intelligence (AI) tools that connect to Connect AI:

* [Agent Bricks](/en/Clients/AgentBricks-Client)
* [Amazon Quick](/en/Clients/AmazonQuick-Client)
* [ChatGPT](/en/Clients/ChatGPT-Client)
* [Claude](/en/Clients/Claude-Client)
* [Claude Code](/en/Clients/ClaudeCode-Client)
* [Codex](/en/Clients/Codex-Client)
* [CrewAI](/en/Clients/CrewAI-Client)
* [Cursor](/en/Clients/Cursor-Client)
* [Gemini](/en/Clients/Gemini-Client)
* [Gemini Enterprise](/en/Clients/GeminiEnterprise-Client)
* [GitHub Copilot](/en/Clients/GitHubCopilot-Client)
* [Grok](/en/Clients/Grok-Client)
* [LangChain](/en/Clients/LangChain-Client)
* [LangGraph](/en/Clients/LangGraph-Client)
* [LlamaIndex](/en/Clients/LlamaIndex-Client)
* [Lovable](/en/Clients/Lovable-Client)
* [Microsoft Copilot Studio](/en/Clients/MicrosoftCopilot-Client)
* [Microsoft Foundry](/en/Clients/MicrosoftFoundry-Client)
* [Mistral Le Chat](/en/Clients/Mistral-Client)
* [n8n](/en/Clients/N8N-Client)
* [Replit Agent](/en/Clients/Replit-Client)
* [Windsurf](/en/Clients/Windsurf-Client)

### BI and Reporting Tools

Below is a list of the Business Intelligence (BI) and Reporting tools that connect to Connect AI:

* [Alteryx](/en/Clients/Alteryx-Client)
* [Amazon QuickSight](/en/Clients/AmazonQuickSight-Client)
* [Azure Analysis Services](/en/Clients/AAS-Client)
* [APOS](/en/Clients/APOS-Client)
* [Crystal Reports](/en/Clients/CrystalReports-Client)
* [Excel](/en/Clients/Excel365-Client)
* [Geckoboard](/en/Clients/Geckoboard-Client)
* [Google Sheets](/en/Clients/GoogleSheets-Client)
* [IBM Cognos Analytics](/en/Clients/IBMCognos-Client)
* [Looker](/en/Clients/Looker-Client)
* [Looker Studio](/en/Clients/LookerStudio-Client)
* [Metabase](/en/Clients/Metabase-Client)
* [Microsoft Fabric](/en/Clients/MicrosoftFabric-Client)
* [MicroStrategy](/en/Clients/MicroStrategy-Client)
* [Mode](/en/Clients/Mode-Client)
* [PowerBI.com](/en/Clients/PowerBI.com-Client)
* [Power BI Desktop](/en/Clients/PowerBIDesktop-Client)
* [Qlik Sense](/en/Clients/QlikSenseCloud-Client)
* [Redash](/en/Clients/Redash-Client)
* [SAP Analytics Cloud](/en/Clients/SAPAnalyticsCloud-Client)
* [SAS Viya](/en/Clients/SASViya-Client)
* [Tableau Cloud](/en/Clients/TableauCloud-Client)
* [Tableau Desktop](/en/Clients/TableauDesktop-Client)
* [ThoughtSpot](/en/Clients/ThoughtSpot-Client)
* [Zoho Analytics](/en/Clients/ZohoAnalytics-Client)

### ETL Tools

Below is a list of the Extract, Transform, and Load (ETL) tools that connect to Connect AI:

* [Airbyte](/en/Clients/Airbyte-Client)
* [AWS Glue](/en/Clients/AWSGlue-Client)
* [Azure Data Factory](/en/Clients/AzureDataFactory-Client)
* [CData Sync](/en/Clients/CDataSync-Client)
* [Cloud Data Fusion](/en/Clients/CloudDataFusion-Client)

### No-Code/Low-Code Tools

Below is a list of No-Code/Low-Code tools that connect to Connect AI:

* [AppSheet](/en/Clients/AppSheet-Client)
* [AWS App Studio](/en/Clients/AWSAppStudio-Client)
* [Azure Logic Apps](/en/Clients/AzureLogicApps-Client)
* [Bubble](/en/Clients/Bubble-Client)
* [Filemaker Pro](/en/Clients/Claris-Client)
* [Mendix](/en/Clients/Mendix-Client)
* [Microsoft Power Apps](/en/Clients/MicrosoftPowerApps-Client)
* [Microsoft PowerAutomate](/en/Clients/MicrosoftPowerAutomate-Client)
* [Nintex](/en/Clients/Nintex-Client)
* [Outsystems](/en/Clients/Outsystems-Client)
* [Retool](/en/Clients/Retool-Client)
* [Salesforce External Services](/en/Clients/SalesforceExternal-Client)
* [Salesforce Lightning Connect](/en/Clients/SFLC-Client)
* [Workato](/en/Clients/Workato-Client)
* [Zapier](/en/Clients/Zapier-Client)

### Dev Tools

Below is a list of the development tools that connect to Connect AI:

* [ADO.NET](/en/Clients/ADO.NET-Client)
* [Apps Script](/en/Clients/AppsScript-Client)
* [Axios](/en/Clients/Axios-Client)
* [Choreo](/en/Clients/Choreo-Client)
* [Databricks](/en/Clients/Databricks-Client)
* [Databricks Lakehouse Federation](/en/Clients/DatabricksLHF-Client)
* [Grafana](/en/Clients/Grafana-Client)
* [JDBC](/en/Clients/JDBC-Client)
* [Node.js](/en/Clients/Nodejs-Client)
* [ODBC](/en/Clients/ODBC-Client)
* [Polybase](/en/Clients/Polybase-Client)
* [Python](/en/Clients/Python-Client)
* [SSIS](/en/Clients/SSIS-Client)
* [SQL Server Linked Server](/en/Clients/SQLServerLinked-Client)

### iPaaS Tools

Below is a list of the Integration Platform as a Service (iPaaS) tools that connect to Connect AI:

* [Jitterbit](/en/Clients/Jitterbit-Client)
* [MuleSoft](/en/Clients/Mulesoft-Client)
* [SnapLogic](/en/Clients/SnapLogic-Client)


# Jobs
Source: https://docs.cloud.cdata.com/en/Jobs

The ***Jobs*** page enables you to manage and run various Connect AI jobs. From this page, you can manage either [Caching](/en/Caching) or [Scheduled Queries](/en/Scheduled-Queries).

<Frame>
  <img alt="Jobs" />
</Frame>

The **Connect AI caching feature** allows you to select tables to be cached, or saved to a database. Connect AI then fetches data for the selected tables on a scheduled basis, ensuring swift and reliable access to data whenever you need it.

Note that when you enable caching of data, Connect AI runs database queries against the *cached* data, not the live data. The cached data is stored in a PostgreSQL database, which you must set up before using the caching feature. You can set up the data warehouse for your cached data by clicking **Set Up Data Warehouse** on the Jobs page. This takes you to the **Add PostgreSQL Connection** page.

Once the data warehouse is set up, you can manage it by clicking **Manage Data Warehouse** at the top of the Jobs page. See [Caching](/en/Caching) for details.

The **Connect AI scheduled queries feature** allows you to write queries in Data Explorer and schedule them to write data to a variety of supported destinations based on a set schedule. Before you use the scheduled queries feature, you must set up a connection that contains the destination tables for the scheduled queries. See [Scheduled Queries](/en/Scheduled-Queries) for details.

The **Jobs** page contains the following information about each job:

* **Name**—the name of the job. For cached jobs, the job name is the table name. For scheduled queries, the job name is user defined.
* **Job Type**—The job type, which is either **Cache** or **Scheduled Query**.
* **Last Run**—The last time the job was run, and the next scheduled run.
* **Status**—The status of the job, which can be one of the following:
  * **Success**—the job completed successfully.
  * **Failed**—the job was unsuccessful. Click anywhere in the job to open the **Edit Job** page. **Edit Job** displays details about why the job failed.
  * **Running**—the job is in progress.
  * **Canceled**—the user canceled the job.
  * **Queued**—the job is queued to run at the time specified in Next Run.
    The toggle switch in the **Status** column indicates whether the job is enabled or disabled. You can disable a job temporarily without deleting it.
* **Job Actions**—The icons in the last column represent the various actions you can perform on a job.
  * **Run (▷)**—Run the selected job immediately. You can run several jobs at once by selecting the jobs to run and clicking the **Run** button on the top of the page.
  * **Edit (🖉)**—Edit the selected job in the **Edit Job** page.
  * **Delete (🗙)**—Delete the selected job. You can delete several jobs at once by selecting the jobs to delete and clicking the **Delete** button at the top of the page.

Click **+Add Job** to add a new cache job or scheduled query. Note that you cannot add a cache job until you set up the data warehouse.

### Filtering

The section above the jobs table allows you to filter jobs by name, job type, last run, and/or status.

* **Name**—displays only jobs matching the job name.
* **Job Type**—select whether to display only cached jobs or only scheduled queries.
* **Last Run**—displays only jobs that were last run in the given date range (such as the last 7 days) or a custom date range selected from the date picker.
* **Status**—displays only jobs that have a certain status (success, failed, running, canceled, or queued).

Click **Apply** to apply the selected filter(s) to the jobs table and perform a search. Click **Clear all** to start over.


# LLM Gateway
Source: https://docs.cloud.cdata.com/en/LLM-Gateway/LLM-Gateway

LLM Gateway is a centrally managed proxy that routes LLM traffic to external providers through a single unified endpoint.

<Note>The LLM Gateway is currently in beta as part of an early access program. More information around joining the program can be found [here](https://www.cdata.com/ai).</Note>

***LLM Gateway*** is a centrally managed proxy that routes LLM requests from your applications and AI agents to external providers. Instead of each application holding its own provider API keys, the CData administrator registers providers once and governs all traffic through a single endpoint. Send requests to `https://cloud.cdata.com/gateway/v1` and Connect AI forwards them to the configured provider. Authenticate using the virtual key you issue on the **Virtual Keys** tab. Your application never holds a raw provider API key.

<Note>The LLM Gateway supports the following external providers: Anthropic, Azure OpenAI, Cohere, Custom OpenAI-compatible providers, Google Gemini, and OpenAI.</Note>

The **LLM Gateway** page contains the following tabs:

* [**Projects**](/en/LLM-Gateway/Projects): Contains a list of projects, each scoped to a routing rule and identified by a user-defined name.
* [**Virtual Keys**](/en/LLM-Gateway/Virtual-Keys): Contains a list of virtual keys for authentication. Virtual keys are the credentials a client sends to the LLM Gateway.
* [**Routing Rules**](/en/LLM-Gateway/Routing-Rules): Contains a list of routing rules that determine where a project's traffic goes: to a single provider, a priority-failover chain, or based on a model allowlist.

## Get Started Using LLM Gateway

The following is an overview of setting up the LLM Gateway. Refer to the linked sections for details.

<Note>You must be have a system role of Administrator to perform these tasks.</Note>

<Steps>
  <Step>
    **Register a provider.** On the [**LLM Providers**](/en/LLM-Gateway/LLM-Providers) page, click **+ Add Provider** and enter your provider name, type, and API key. This is the credential Connect AI uses to forward requests to the LLM provider. Next, select which of the provider's models to use (such as *claude-sonnet-5* for Anthropic or *gpt-4o* for OpenAI).
  </Step>

  <Step>
    **Create a routing rule.** On the [**Routing Rules**](/en/LLM-Gateway/Routing-Rules) tab of the **LLM Gateway** page, click **+ Add Routing Rule** and select a routing name, description, and type. Select **Single provider** to route all traffic to one provider, **Priority Failover** to route to a primary provider with automatic failover, or **Model Allowlist** to approve specific model–provider pairs. With **Model Allowlist**, the client names the model in each request, and the gateway forwards it to the paired provider or refuses it if the model is not on the list. Then configure the targets for your routing rule. If the organization-level default routing rule already suits your needs, you can skip this step and assign it when creating your project.
  </Step>

  <Step>
    **Create a project.** On the [**Projects**](/en/LLM-Gateway/Projects) tab of the **LLM Gateway** page, click **+ Add Project** and follow the instructions for creating a project. Add a project name and description, and then assign the routing rule you created in the previous step, or use the default routing rule. Save the project.
  </Step>

  <Step>
    **Issue a virtual key for the project.** On the **Virtual Keys** tab of your project, or on the [**Virtual Keys**](/en/LLM-Gateway/Virtual-Keys) tab of the main **LLM Gateway** page, click **+ Issue Virtual Key** and follow the instructions for issuing a virtual key.
  </Step>

  <Step>
    **Send requests through the gateway.** Point your LLM client at the Base URL for your LLM and authenticate with the virtual key, as follows:

    <Steps>
      <Step>
        **Choose your Base URL.** On the **Projects** tab of the **LLM Gateway** page, click **View Endpoints** to open a dialog showing the Gateway URL: `https://cloud.cdata.com/gateway/v1`.

        This URL is already complete. Do not add a suffix.
      </Step>

      <Step>
        **Configure your client.** Set your client's **Base URL** to the endpoint you copied. Pass the virtual key as the `Authorization: Bearer <virtual-key>` header or as the `x-api-key` header. The gateway selects the provider and model based on the project's routing rule.
        <Note>A Connect AI Personal Access Token is not accepted here; only the virtual key binds a request to its project.</Note>
      </Step>

      <Step>
        **Make a test request.** The following examples show a minimal request using different SDKs against the same base URL. Replace `<virtual-key>` with the key you issued.

        <CodeGroup>
          ```bash OpenAI-compatible (curl) theme={null}
          curl https://cloud.cdata.com/gateway/v1/chat/completions \
            -H "Authorization: Bearer <virtual-key>" \
            -H "Content-Type: application/json" \
            -d '{
              "messages": [{"role": "user", "content": "Hello"}]
            }'
          ```

          ```python OpenAI SDK (Python) theme={null}
          from openai import OpenAI

          client = OpenAI(
              base_url="https://cloud.cdata.com/gateway/v1",
              api_key="<virtual-key>",
          )

          response = client.chat.completions.create(
              messages=[{"role": "user", "content": "Hello"}],
          )
          print(response.choices[0].message.content)
          ```

          ```python Anthropic SDK (Python) theme={null}
          import anthropic

          client = anthropic.Anthropic(
              base_url="https://cloud.cdata.com/gateway/v1",
              api_key="<virtual-key>",
          )

          message = client.messages.create(
              max_tokens=1024,
              messages=[{"role": "user", "content": "Hello"}],
          )
          print(message.content)
          ```
        </CodeGroup>
      </Step>
    </Steps>
  </Step>
</Steps>


# LLM Providers
Source: https://docs.cloud.cdata.com/en/LLM-Gateway/LLM-Providers

Register and manage LLM provider credentials for the LLM Gateway.

The ***LLM Providers*** page contains a list of available LLM providers, models, and the API keys the gateway uses to reach them. LLM Gateway supports the following external providers: Anthropic, Azure OpenAI, Cohere, Custom OpenAI-compatible providers, Google Gemini, and OpenAI.

<Frame>
  <img alt="LLM Gateway Providers" />
</Frame>

Each provider displays the following information:

* **Provider**—the user-friendly name and type of the LLM provider.
* **Models**—the LLM you are using (for example, *gpt-4o* or *claude-sonnet-5*).
* **Status**—the status of the LLM provider: **Active** or **Inactive**.
* **API Key**—a masked representation of the API key obtained from the LLM provider. The API key cannot be edited after the provider is registered. To update an API key, delete the provider and re-add it.

Each provider also contains edit and delete icons. On the edit page of the provider, you can edit the provider's **Name** and add or delete **Models**. Click **Save Changes** when finished. Click the delete icon to remove the provider.

<Note>You must be have a system role of Administrator to add, edit, or delete providers. Non-administrators can view this page but cannot make any changes.</Note>

## Add a Provider

<Note>For each provider, obtain your API key from that provider's developer console before registering.</Note>

To register a new LLM provider, do the following:

<Steps>
  <Step>
    Click **+ Add Provider**. An **Add LLM Provider** dialog appears.
  </Step>

  <Step>
    Enter the following information about the provider (Step 1):

    * **Name**—enter a friendly name for the provider.
    * **Provider**—select a supported provider type.
    * **Base URL**—(Azure OpenAI only) enter the base endpoint for the provider, for example, *[https://my-endpoint.example.com/v1](https://my-endpoint.example.com/v1)*.
    * **API Key**—enter the provider's API key.
  </Step>

  <Step>
    Add the LLM models to use for the provider (Step 2). Click **+ Add Model** and enter the model name. Repeat to add additional models.
  </Step>

  <Step>
    When you are finished adding models, click **Add**. The LLM provider appears on the **LLM Providers** page with a status of **Active**.
  </Step>
</Steps>


# Logs
Source: https://docs.cloud.cdata.com/en/Logs

The ***Logs*** page in the navigation menu consists of two tabs:

* **Query Log**—the query log contains details about the queries that are made to your Connect AI account.
* **Audit Log**—the audit log records administrative tasks, including user creation, permission changes, and more.

## Query Log

The **Query Log** tab displays a list of performed queries and the following information for each one:

* **Timestamp**—the time when the query occurs, formatted as *YYYY*-*MM*-*DD* *HH*:*MM*:*SS* AM/PM UTC.
* **Query Type**—the category of the query.
* **User**—the login Id of the Connect AI user who makes the query.
* **Status**—the final state of the query; that is, whether it succeeded or failed.
* **Connection**—the connection used to run the query.
* **Query Text**—the text and destination of the query.
  <Frame>
    <img alt="Query log" />
  </Frame>

At the bottom of the query table, you can select the number of queries to display per page and you can navigate among pages of results.

### Query Details

Clicking any query in the log expands the query and displays detailed information about it. The fields and contents can vary among queries of different types.

<Frame>
  <img alt="Query details" />
</Frame>

You can click the **Logs** button in a query details section to download a log file that contains details about the query. These log files are useful in troubleshooting errors that are related to issuing queries to Connect AI.

<Note>
  * You can increase or decrease the logging verbosity for a connection on the **Advanced Settings** page for that connection. The default verbosity is 2. See [Data Sources](/en/Data-Sources#logging-verbosity) for more information.
  * Connect AI saves log files for seven days only. Log files older than seven days are deleted automatically.
</Note>

### Filtering

The section above the query table allows you to filter queries by Query Id, date range, query type, user, and/or status.

* **Date Range**—displays only queries that match the given date range (such as the last 7 days) or a custom date range selected from the date picker.
* **Query Type**—displays only queries of the type that you select.
* **Connections**—displays only queries of the connection that you select.
* **User**—displays only queries that are performed by the specified user.
* **Status**—displays only queries that were a success or that failed.
* **Query Text or Query Id**—displays only queries that include the entered text or match the Query Id.
  <Frame>
    <img alt="Query filter" />
  </Frame>

Click **Apply** to apply the selected filters to the query table and perform a search. Click **Clear all** to start over.

## Audit Log

The **Audit Log** tab displays a list of audit events and the following information for each event:

* **Timestamp**—the time when the event occurs, formatted as *YYYY*-*MM*-*DD* *HH*:*MM*:*SS* AM/PM UTC.
* **Event Type**—the category of audit event.
* **User**—the login Id of the Connect AI user who performs the administrative task.
* **Source**—where the event took place (for example, **Dashboard** or **MCP**).
* **Target Resource**—the category and the name of the targeted resource.
  <Frame>
    <img alt="Audit log" />
  </Frame>

At the bottom of the audit table, you can select the number of entries to display per page and navigate among pages of results.

### Audit Details

Clicking any entry in the audit log expands the entry and displays detailed information about it. The fields and content can vary among entries of different types. Some entries do not have any detailed information to display.

<Frame>
  <img alt="Audit details" />
</Frame>

### Filtering

The section above the audit log enables you to filter entries by date range, event type and user.

* **Date Range**—displays only entries that match the given date range (such as last 7 days) or a custom date range selected from the date picker.
* **Event Type**—displays only entries of the type that you select.
* **Source**—displays only the source type selected.
* **User**—displays only entries that are performed by the specified user name.
  <Frame>
    <img alt="Audit filter" />
  </Frame>

Click **Apply** to apply the selected filters to the audit log table and perform a search. Click **Clear all** to start over.


# MCP Gateway
Source: https://docs.cloud.cdata.com/en/MCP-Gateway

Configure and manage MCP tool servers for governed AI agent access.

The ***MCP Gateway*** page is where you configure the tool servers, or the MCP endpoints your agents connect to.

## Tool Servers

**Tool Servers** lists your tool servers and their agent URLs. Use the search bar to filter tool servers by name.

<Frame>
  <img alt="MCP Gateway Tool Servers" />
</Frame>

**Tool Servers** contains the following information about each tool server:

* **Name**—the user-defined name of the tool server.
* **MCP Servers**—icons representing the MCP servers your agent is connected to through the tool server.
* **Agent URL**—the endpoint URL your agents connect to, generated automatically when you create the tool server. Click the copy icon to copy the endpoint into your AI client.

Each row includes edit and delete icons. Selecting one or more rows with the checkboxes reveals a **Delete** button to remove them in bulk.

<Note>You must be have a system role of Administrator to add, modify, or delete a tool server. Non-administrators can view tool servers and connect to their own upstream accounts.</Note>

Tool servers that include 3rd party MCP servers also show a **How to Connect** link. Clicking it opens a dialog with instructions for connecting your agent to that tool server.

### Add a Tool Server

<Steps>
  <Step>
    Click **+ Add Tool Server**. An **Add Tool Server** dialog appears.
  </Step>

  <Step>
    In **Step 1: Details**, enter a **Name** for your tool server. Names must use lowercase letters, numbers, hyphens, and dots only. Click **Next**.
  </Step>

  <Step>
    In **Step 2: Select MCP Servers**, add the MCP servers to bundle in this tool server.

    The left pane summarizes the servers in this tool server: the number of CData Source MCPs selected and a list of any 3rd party MCP servers added. The right pane is the browse and configuration area.

    **CData Source MCPs**: In the right pane, browse or search for the data source MCPs available in your Connect AI workspace. Select the checkbox next to each source you want to include. Each entry shows the tool prefix applied to that source's tools (for example, *mailchimp2\_\**). The left pane updates to show the number of selected sources.

    **3rd Party MCP Servers** (optional): In the left pane, click **+ Add 3rd Party MCP Server**. An entry form appears on the right. Enter the following information:

    * **Name**—a name for this MCP server. The name is used as a prefix on this server's tool names to keep them distinct.
    * **Upstream MCP URL**—the endpoint of the upstream MCP server. Must be an HTTPS endpoint serving MCP over HTTP+SSE or Streamable HTTP.
    * **Authentication**—select the authentication type and follow the relevant instructions below.

    <Tabs>
      <Tab title="Per-user OAuth (automatic setup)">
        The upstream server uses OAuth with user consent. Connect AI handles the OAuth flow automatically. This authentication type requires no additional fields.
      </Tab>

      <Tab title="Per-user token">
        Each user provides their own token to authenticate with the upstream server. After the tool server is created, click **How to Connect** in the Tool Servers list to open a dialog where you can enter your token.
      </Tab>
    </Tabs>

    Click **+ Add 3rd Party MCP Server** again to add additional servers to this tool server.
  </Step>

  <Step>
    Click **Add**. The new tool server appears in the **Tool Servers** list with an automatically generated **Agent URL**.
  </Step>
</Steps>

<Note>
  **Step 3: Configure Tools** is coming soon. The tool server currently exposes every tool on every upstream server.
</Note>

## Connect to a Tool Server

Copy the **Agent URL** from the **Tool Servers** list and configure your AI client to use it as an MCP server.

If the tool server includes 3rd party MCP servers, click **How to Connect** to complete authentication. For **Per-user OAuth**, you are prompted to sign in to the upstream server in a browser. For **Per-user token**, enter your token in the dialog.


# Navigation Menu
Source: https://docs.cloud.cdata.com/en/Navigation-Menu

The navigation menu serves as the connection and configuration center for your Connect AI account. It contains links to each section of Connect AI. When you log in, the **Dashboard** page displays.

<Frame>
  <img alt="Navigation menu" />
</Frame>

<Note>Your navigation menu may look different depending on which features of Connect AI you have.</Note>

Click the name of a section in the list below for more details about that section of Connect AI:

* **[Dashboard](/en/Dashboard)** provides a concise view of information for connections and queries.
* **[Playground](/en/Playground)** provides an interface to connect your integrations to AI, connect various sources to CData's MCP server, and to ask Connect AI natural-language questions about your data.
* **[MCP Gateway](/en/MCP-Gateway)** allows you to configure and manage MCP tool servers for governed AI agent access.
* **[Toolkits](/en/Toolkits)** provides an area to create custom MCP tools for repeatable operations in your AI-driven workflows.
* **[Sources](/en/Sources)** contains controls for adding and managing data sources.
* **[Integrations](/en/Integrations)** provides assistance with connecting integration tools to Connect AI.
* **[Workspaces](/en/Workspaces)** provides assistance with creating and managing Connect AI workspaces and assets.
* **[Explorer](/en/Data-Explorer)** provides the ability to manage queries and derived views for your connections.
* **[Jobs](/en/Jobs)** enables you to create, manage, and run caching and scheduled query jobs.
* **[LLM Gateway](en/LLM-Gateway/LLM-Gateway)** enables you to route requests to your AI providers, scope monthly spending to a project, and issue virtual keys your clients authenticate with.
* **[Context Editor](/en/Context-Editor)** manages what AI agents know about you and your data to get faster, more accurate answers to your questions.
* **Identities** enable you to manage the **[Users](/en/Users)**, **[Service Accounts](/en/Service-Accounts)**, and **[Roles](/en/Roles)** and control their access.
* **[LLM Providers](/en/LLM-Gateway/LLM-Providers)** contains credentials for your LLM providers, including API keys.
* **[Logs](/en/Logs)** contains detailed logs for your Connect AI account.
* **[Data Security](/en/Data-Security)** enables you to create rules for protecting sensitive data before it reaches your AI workflows.
* **[API](/en/API/API)** provides documentation for connecting to data via REST API, OData, or OpenAPI.

The top navigation bar of Connect AI contains the following items:

* A clickable icon that toggles the display of the left-pane navigation menu:
  <Frame>
    <img alt="Menu collapse" />
  </Frame>
* A Question Mark icon, which opens this documentation to the **[Getting Started](/en/docs)** page.
* A Gear Icon, which opens your Connect AI **[Settings](/en/Settings)**.
* Your username, which you can click to open a drop-down menu that allows you to contact support or sign out.


# Playground
Source: https://docs.cloud.cdata.com/en/Playground

The ***Playground*** page enables you to harness AI to get answers from your connected data. The Playground interface provides connection assistance to many common data sources, such as Jira, GitHub, and Slack. Once you are connected, you can ask natural-language questions about the data in the sources.

## Connect to Your Data

Connect AI's Playground allows you to connect data sources to CData's remote MCP server and obtain insights from your data in real time without a third-party integration tool.

<Frame>
  <img alt="Playground" />
</Frame>

The home page of Playground contains commonly used data sources. Click **Explore Additional Sources** for more options. Click a source, and if the source is not already connected, Connect AI guides you through the appropriate steps to connect the source.

<Note>Click **Connect Integrations** if you want to use a third-party integration tool (such as ChatGPT) to query your data rather than Connect AI Playground.</Note>

For example, click the **Atlassian Jira** tile. If you are not yet connected, the Playground AI asks for your Jira URL to connect to the account. Once you submit a valid URL, the AI creates the Jira connection and asks you to authenticate it using OAuth. Save the connection.

<Frame>
  <img alt="Authenticate Jira" />
</Frame>

After you set up the Jira account, the Playground first checks if you have user-level or connection-level context, or instructions, about how AI should query your data. See [Context Editor](/en/Context-Editor) for more information.

<Note>Adding information in the Context Editor improves the prompt's answers, but it is not required.</Note>

Next, Playground runs a sample prompt to make sure you are connected to the data source, such as "Give me the 5 most recent tickets created in Jira and give me the summary." When the prompt is successful, submit your own prompt. The remote MCP server works to access the relevant catalogs, schemas, and tables. The Playground might prompt you for more information to narrow down the data you need.

You can expand the results of the prompt to obtain details about how the AI tools accessed the data:

<Frame>
  <img alt="Expand prompt results" />
</Frame>

In the example above, the prompt called the tools `getCatalogs`, `getSchemas`, and `executeQuery`.

Click **Reset Chat** to return to the Playground main menu and connect additional data sources.

## Chat Records

Chat records are saved for 30 days so you can return to them later. Click the three dots to the right to rename your prompt or delete it permanently.

## Examples

The following are some of the questions you can ask Playground about your data:

* ***In my Salesforce connection, which deals have we closed in the past month, and what is the total?***

* ***In my LinkedIn Ads connection, summarize the performance for the last 30 days by campaign.***

* ***Which e-commerce products generate the highest gross margin according to NetSuite?***

* ***Identify Salesforce stalled opportunities and explain why they're at risk.***

For a more complete list of prompt ideas, see the CData [prompt library](https://www.cdata.com/ai/prompt-library/). You can filter prompts by data source.

## Ask AI to Search the Documentation

Playground also lets you ask questions about the Connect AI documentation. For example, you can ask Playground: "How do I connect to my Salesforce data?" or "How do I change my email address?" Playground might ask follow-up questions to further assist you.

## Limitations

Playground operates within specific boundaries, as follows:

* **Permissions**: Access to data, including the ability to run queries, is based on catalog permissions granted to the user. Tools such as `getSchemas`, `getTables`, `getColumns`, `getCatalogs`, and `executeQuery` are only accessible with sufficient catalog permissions.

  <Warning>Playground does not perform data deletion queries under any circumstances.</Warning>

* **Query Limits**: Only SELECT, INSERT, UPDATE, and stored procedures are supported. Query responses also cannot exceed 100 rows.

* **Execution**: Actions are limited to the Connect AI ecosystem. Actions or queries outside of the system are ignored.

* **Privacy and Security**: Playground accesses only relevant data and metadata within the Connect AI system. It does not query data or systems outside of authorized Connect AI catalogs.


# Quick Start
Source: https://docs.cloud.cdata.com/en/Quick-Start-Guide

Connect an AI agent to Connect AI via MCP and answer a question about real data, using either a public sample file or your own data source.

Connect an AI agent to your data through [Model Context Protocol (MCP)](/en/API/MCP) and answer a question
about that data. Expect to spend a few minutes in your terminal and a few in the Connect AI application.

In this guide, you will use a coding agent, such as Claude Code, to query your data via MCP. You will
also learn how to create a connection in the web interface or from the command line. To reach your data
from Power BI, Excel, or Tableau instead, see [Integrations](/en/Integrations).

<Tip>
  Not ready to use your own data? Step 3 offers a public weather file that requires no credentials.
  It exercises the same setup, so you can prove the connection works before involving real data. See
  Step 3, **Use the Web Interface** tab for details.
</Tip>

## Step 1: Sign Up

Go to [Connect AI](https://cloud-login.cdata.com/u/signup) and create a free account. The [pricing page](https://www.cdata.com/ai/pricing/) lists what each plan includes.

If you already have an account, [log in](https://cloud.cdata.com/) instead.

## Step 2: Connect Your Agent

Connect AI exposes a single remote MCP server at *[https://mcp.cloud.cdata.com/mcp](https://mcp.cloud.cdata.com/mcp)*. Point your agent at
that URL and authorize it with OAuth in the browser. The agent can then discover and query every source
you connect.

Connecting the agent first means it is ready to use right after you add a data source, and it lets the
agent create the connection for you.

<Tabs>
  <Tab title="Claude" icon="comment">
    Connect AI publishes a connector in the Claude connector directory, so no configuration file is
    required.

    1. Log in to [Claude](https://claude.ai).
    2. Click your user name in the bottom-left corner, select **Settings**, and then click **Connectors**.
    3. Click **Browse connectors** and search for *CData Connect AI*.
    4. Click **CData Connect AI**, click **Connect**, and grant access.
  </Tab>

  <Tab title="Claude Code" icon="terminal">
    Run the following command in your terminal:

    ```bash wrap theme={null}
    claude mcp add --transport http connectai https://mcp.cloud.cdata.com/mcp
    ```

    Adding the server registers it but does not authenticate it. Complete the sign-in from inside a
    session:

    1. Type `claude` to start a session, and then run the `/mcp` command.
    2. Select the `connectai` server, and then choose **Authenticate**. Claude Code opens your browser to
       the Connect AI sign-in page.
    3. Complete the sign-in. When you return to the terminal, the server status changes to connected.

    For installation instructions, see the [Claude Code documentation](https://code.claude.com/docs/en/overview).
  </Tab>

  <Tab title="ChatGPT" icon="comments">
    Connect AI publishes an app in the ChatGPT app directory, so no configuration file is required. This
    path needs a ChatGPT Plus or Pro subscription.

    1. Sign in to [ChatGPT](https://chatgpt.com).
    2. Click **Apps** in the left panel.
    3. Search for *CData Connect AI* and select it.
    4. Click **Connect**, click **Sign in with CData Connect AI**, and complete the sign-in.
    5. Click **Start chat**. If Connect AI is not already enabled, click **+**, select **More**, and then
       select **CData Connect AI**.

    The ChatGPT Apps feature is in beta and its setup steps change. For the current steps and screenshots,
    see [ChatGPT](/en/Clients/ChatGPT-Client).
  </Tab>

  <Tab title="Copilot Studio" icon="windows">
    Copilot Studio reaches Connect AI as a tool on an agent that you create.

    1. In the Copilot Studio navigation menu, click **Agents**, and then click **+ New agent**. Configure
       the agent, and then click **Create**.
    2. On the agent details page, click **Add tool**.
    3. Search for *CData Connect AI* and click it.
    4. Under **Connection**, click **Create new connection**, and then click **Create**.
    5. Sign in to Connect AI, and then click **Add to agent**.

    The tool appears under **Tools** on your agent. For the full walkthrough with screenshots, see
    [Microsoft Copilot Studio](/en/Clients/MicrosoftCopilot-Client).
  </Tab>

  <Tab title="Gemini" icon="google">
    Create a `.gemini` folder in your user directory, and inside it create a file named `settings.json`
    with the following configuration:

    ```json theme={null}
    {
      "mcpServers": {
        "connectai": {
          "httpUrl": "https://mcp.cloud.cdata.com/mcp/",
          "trust": true
        }
      },
      "selectedAuthType": "oauth-personal"
    }
    ```

    Type `gemini` in your terminal, and then run `/mcp auth connectai`. Gemini opens your browser to the
    Connect AI sign-in page.

    Gemini requires Python 3.10 or later. To connect through the Google Agent Development Kit instead, see
    [Gemini](/en/Clients/Gemini-Client).
  </Tab>

  <Tab title="Cursor" icon="code">
    **One-click install:** [Add Connect AI to Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=connectai\&config=eyJ1cmwiOiJodHRwczovL21jcC5jbG91ZC5jZGF0YS5jb20vbWNwIn0%3D). Cursor opens and prompts you
    to confirm.

    To configure it manually instead, open **Cursor Settings**, click **Tools & MCP**, and then click
    **New MCP Server**. The file `mcp.json` opens automatically. Add the following configuration:

    ```json theme={null}
    {
      "mcpServers": {
        "connectai": {
          "url": "https://mcp.cloud.cdata.com/mcp"
        }
      }
    }
    ```

    Return to **Tools & MCP**. Cursor detects that the server requires OAuth and opens your browser to the
    Connect AI sign-in page. After you sign in, **connectai** appears with a green indicator.
  </Tab>

  <Tab title="Visual Studio Code" icon="file-code">
    **One-click install:** [Add Connect AI to Visual Studio Code](https://vscode.dev/redirect/mcp/install?name=connectai\&config=%7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.cloud.cdata.com%2Fmcp%22%7D).

    To configure it manually instead, create a folder named `.vscode` in your project. Inside it, create a
    file named `mcp.json` with the following configuration:

    ```json theme={null}
    {
      "servers": {
        "connectai": {
          "type": "http",
          "url": "https://mcp.cloud.cdata.com/mcp"
        }
      },
      "inputs": []
    }
    ```

    Click **Start** in your IDE to start the MCP server. Visual Studio Code opens your browser to the
    Connect AI sign-in page. After authorization, the server displays **Running**.
  </Tab>

  <Tab title="Other Clients" icon="plug">
    The community `add-mcp` tool registers a remote MCP server across most coding agents, including Claude
    Desktop, Codex, Gemini CLI, Goose, OpenCode, and Zed. Run `npx add-mcp list-agents` for the current list:

    ```bash wrap theme={null}
    npx add-mcp https://mcp.cloud.cdata.com/mcp
    ```
  </Tab>
</Tabs>

For setup instructions for other clients, including GitHub Copilot, Gemini Enterprise, Windsurf, and
n8n, see [AI Tools](/en/Clients/AITools).

<Note>
  This guide uses OAuth, which requires no token management. To use Basic authentication with a
  personal access token instead, see [Authentication](/en/API/Authentication).
</Note>

## Step 3: Add a Data Source

Your agent is connected but has nothing to read yet. Choose how you want to create the connection. The
web interface handles any source, including the sample weather file. The other two paths drive the
[Management MCP](/en/API/MCP-Management) server, which configures OAuth sources such as Google Sheets
and Salesforce. Whichever you choose, the rest of this guide is identical afterward.

<Tabs>
  <Tab title="Ask Your Agent" icon="robot">
    The Management MCP server creates and tests connections programmatically, so the agent you connected in
    Step 2 can set the source up for you. Register a second server alongside the first, at
    *[https://mcp.cloud.cdata.com/mcp/mgmt](https://mcp.cloud.cdata.com/mcp/mgmt)*, using whichever method you used in Step 2, and authorize it the
    same way. In Claude Code that is:

    ```bash wrap theme={null}
    claude mcp add --transport http connectai-mgmt https://mcp.cloud.cdata.com/mcp/mgmt
    ```

    Now describe the source you want instead of configuring it through the user interface. Pick one of the
    two below.

    **Google Sheets, your own data, one Google sign-in:**

    ```text wrap theme={null}
    Using the connectai-mgmt MCP server, create a Google Sheets connection named GoogleSheets that authenticates with OAuth.
    ```

    **Salesforce, your own data.** A Salesforce administrator must
    [install the CData connector](/en/Data-Sources/Salesforce) once before the first connection works:

    ```text wrap theme={null}
    Using the connectai-mgmt MCP server, create a Salesforce connection named Salesforce that authenticates with OAuth.
    ```

    The agent calls `list_available_sources` to confirm the source, `get_source_properties` to discover the
    required fields, and `create_connection` to save it. Keep the connection names above, because the rest
    of this guide refers to them.

    Both sources use OAuth, so the agent returns a sign-in URL rather than a finished connection. Open it in
    a browser and grant access, then ask the agent to confirm the result:

    ```text wrap theme={null}
    Using the connectai-mgmt MCP server, test that connection and list the tables it exposes.
    ```

    Every plan includes the Management MCP server. For the full tool list, see [Management MCP](/en/API/MCP-Management).
  </Tab>

  <Tab title="Use the Web Interface" icon="window-maximize">
    Pick one of the three sources below and follow its steps.

    <AccordionGroup>
      <Accordion title="Sample weather file: fastest, no authentication">
        <Steps>
          <Step>
            Open **Sources** > **+ Add Connection**, type *CSV* in the search field, and then click **CSV**.
          </Step>

          <Step>
            Enter *SampleData* as the connection name. The rest of this guide refers to the connection by this
            name, so use it exactly.
          </Step>

          <Step>
            Enter the following **URI**:

            ```text wrap theme={null}
            https://cdn.jsdelivr.net/npm/vega-datasets@2.11.0/data/seattle-weather.csv
            ```
          </Step>

          <Step>
            In the **Authentication** section, select *HTTPS* from the **Connection Type** list. **Auth Scheme**
            then defaults to *None*, which is correct: the file is public, so no credentials are required.

            <Note>
              This page has two fields named **Connection Type**. The one to change is in the **Authentication**
              section, below the **URI** box. Leave the **Connection Type** selector above it set to **Direct**.
            </Note>
          </Step>

          <Step>
            Leave **FMT** set to *CsvDelimited* and **Include Column Headers** turned on. Both are the defaults.
          </Step>

          <Step>
            Click **Save and Test**. A **Connection successfully saved** message confirms that Connect AI reached
            the file.
          </Step>
        </Steps>

        The connection holds 1,461 daily weather records.
      </Accordion>

      <Accordion title="Google Sheets: your own data, one Google sign-in">
        <Steps>
          <Step>
            Open **Sources** > **+ Add Connection**, type *Google Sheets* in the search field, and then click
            **Google Sheets**.
          </Step>

          <Step>
            Enter a connection name or keep the default name.
          </Step>

          <Step>
            Select **OAuth** as the authentication method.
          </Step>

          <Step>
            (Optional) To improve performance, enter a comma-separated list of sheet names or IDs in the
            **Spreadsheet** field, or enter a **Folder Name**.
          </Step>

          <Step>
            Click **Sign in with Google**, and then log in and grant the requested permissions.
          </Step>

          <Step>
            Click **Save and Test**.
          </Step>
        </Steps>

        Your spreadsheets are now queryable, with each sheet exposed as a table.
      </Accordion>

      <Accordion title="Salesforce: your own data, needs a one-time admin step first">
        A Salesforce administrator must [install the CData connector](/en/Data-Sources/Salesforce) once before
        the first connection on your account works.

        <Steps>
          <Step>
            Open **Sources** > **+ Add Connection**, type *Salesforce* in the search field, and then click
            **Salesforce**.
          </Step>

          <Step>
            Enter a connection name or keep the default name.
          </Step>

          <Step>
            Select **OAuth** as the authentication method.
          </Step>

          <Step>
            Set **Use Sandbox** to **True** if you are connecting to a sandbox account. Otherwise, leave it as
            **False**.
          </Step>

          <Step>
            Click **Sign in**, and then log in to Salesforce and grant the requested permissions. Connect AI uses
            its own registered application, so no client ID or client secret is required.
          </Step>

          <Step>
            Click **Save and Test**.
          </Step>
        </Steps>

        You can now query **Account**, **Opportunity**, **Contact**, and other objects in real time.
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Manual Setup" icon="terminal">
    The [Management MCP](/en/API/MCP-Management) server is an HTTP endpoint, so `curl` and a personal access
    token do the same work
    with no agent. Take this path to drive the setup from a script or a runbook.

    **Create a personal access token.** Go to the [Personal Access Tokens](/en/Settings/Personal-Access-Tokens) page and
    create one. Basic authentication takes your email address as the user name and the token as the
    password. See [Authentication](/en/API/Authentication).

    **Confirm the server answers.** Run this before sending anything that matters:

    ```bash wrap theme={null}
    curl -X POST https://mcp.cloud.cdata.com/mcp/mgmt \
      -u "<YOUR_EMAIL>:<YOUR_PAT>" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json, text/event-stream" \
      -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
    ```

    The response lists the management tools, including `create_connection` and `test_connection`.

    **Check which sources this endpoint can configure.** `create_connection` handles 21 OAuth sources, not
    every source Connect AI supports:

    ```bash wrap theme={null}
    curl -X POST https://mcp.cloud.cdata.com/mcp/mgmt \
      -u "<YOUR_EMAIL>:<YOUR_PAT>" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json, text/event-stream" \
      -d '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"list_available_sources","arguments":{}}}'
    ```

    Each entry carries an `mcpCreatable` flag. Sources that take a file location rather than a sign-in, such
    as the sample weather file, report `false`; create those on the **Use the Web Interface** tab.

    **Create the connection.** Ask `get_source_properties` which fields the source expects, and then pass
    them in `properties`:

    ```bash wrap theme={null}
    curl -X POST https://mcp.cloud.cdata.com/mcp/mgmt \
      -u "<YOUR_EMAIL>:<YOUR_PAT>" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json, text/event-stream" \
      -d '{"jsonrpc":"2.0","id":3,"method":"tools/call","params":{"name":"create_connection","arguments":{"name":"GoogleSheets","source":"GoogleSheets","properties":{"AuthScheme":"OAuth"}}}}'
    ```

    The response includes the new connection's `id` and a sign-in URL. Open the URL in a browser and grant
    access — OAuth requires this authorization step for every source this endpoint creates.

    **Test it.** Substitute the `id` from the previous response:

    ```bash wrap theme={null}
    curl -X POST https://mcp.cloud.cdata.com/mcp/mgmt \
      -u "<YOUR_EMAIL>:<YOUR_PAT>" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json, text/event-stream" \
      -d '{"jsonrpc":"2.0","id":4,"method":"tools/call","params":{"name":"test_connection","arguments":{"id":"<CONNECTION_ID>"}}}'
    ```

    To connect Google Sheets or Salesforce this way instead, call `get_source_properties` first to get the
    field names that source expects, and then pass them in `properties`. Both use OAuth, so the
    `create_connection` response returns a sign-in URL to open in a browser rather than a finished
    connection.
  </Tab>
</Tabs>

<Check>
  You now have a queryable data source. Whichever path you chose, your agent from Step 2 can already
  reach it.
</Check>

These three are examples. The same steps work for every supported source, and each source has its own
page with the exact fields it needs, the prerequisites, and any additional authentication methods it
supports. Find your data source under the **Data Sources** heading in the table of contents. Sources
marked **Premium** in the **Add Connection** list, such as Snowflake and Google BigQuery, require a
Growth plan or higher.

## Step 4: Ask a Question

First, confirm that your agent reaches Connect AI at all:

```text wrap theme={null}
Using the connectai MCP server, list the data sources you can see.
```

The agent calls `getCatalogs` and returns the connection you just made. That confirms both the client
setup from Step 2 and the connection from Step 3.

Now ask a real question. Name the server in your prompt so that you can confirm the answer came from
Connect AI rather than from the model's own knowledge. If you connected the sample weather file:

```text wrap theme={null}
Using the connectai MCP server, query the SampleData connection and tell me how many days of each weather type there are, along with the average high temperature for each.
```

The agent discovers the connection and the table on its own, then writes and runs the SQL. You do not
write the query yourself. Expect five weather types, with rain and sun close to 640 days each. That is
how you know the answer came from your data rather than from the model.

The same pattern applies to your own sources. Substitute your connection, schema, and table names:

```text wrap theme={null}
Using the connectai MCP server, show me the largest open Salesforce opportunities closing in the next 90 days.
```

<Check>
  **You made your first MCP query.** Your agent discovered the data model and queried live data
  through Connect AI, without any source-specific code.
</Check>

If you used the sample file, this is the moment to connect something real. Your agent is already
authorized, so nothing in Step 2 changes. Only Step 3 repeats, and you can ask the same agent about the new
source in the same session. See the documentation for your data source for the fields it needs.

## Troubleshooting

Check the connection one layer at a time. The first check that fails tells you where the problem is.

**Confirm the client registered the server.** For Claude Code, run `claude mcp list`:

| Status | What it means | What to do |
| :- | :- | :- |
| Connected | The server is registered and reachable. | Nothing. |
| Needs authentication | The server is registered but not authorized. | Run `/mcp` in a session and choose **Authenticate**. |
| Failed to connect | The client cannot reach the server. | Confirm the URL and check your network. |

**Confirm the data source works.** Open **Data Explorer** and select your connection. If it returns rows
but your agent does not, the problem is in the client configuration rather than in the connection. If no
tables appear, click **Refresh Metadata** on the **Edit Connection** page.

**See exactly what your agent ran.** Open **Logs** > **Query Log**. Every query your agent sent appears
with a timestamp, the user, a status, and the full query text. Click a row to expand it. This is the
authoritative record of what the agent did, and it is the fastest way to tell a malformed query apart
from a permissions problem. See [Logs](/en/Logs).

**Confirm the server responds, independently of any client.** This separates a Connect AI problem from a
client problem, and it works before any client is configured. Create a personal access token on
the [Personal Access Tokens](/en/Settings/Personal-Access-Tokens) page, then run:

```bash wrap theme={null}
curl -X POST https://mcp.cloud.cdata.com/mcp \
  -u "<YOUR_EMAIL>:<YOUR_PAT>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'
```

A working server returns a list of the tools it offers, including `getCatalogs`, `getTables`, and
`queryData`. For the complete list, see [MCP](/en/API/MCP#mcp-tools).

Other common causes:

* **Told that you are not allowed to perform the requested action?** Creating a connection needs the
  Administrator or Connection Administrator role. Ask an Administrator to grant it or to make the
  connection for you. See [Permissions](/en/Permissions).
* **Authentication errors?** Reauthorize OAuth and confirm scopes.
* **Slow queries?** Filter early and limit columns.
* **Agent cannot find your data?** Confirm it uses fully qualified table names in the form
  *\[Catalog].\[Schema].\[Table]*.

## Ask More of Your Data

The same connection answers new questions with no further setup, and the agent writes fresh SQL each time:

```text wrap theme={null}
Using the connectai MCP server, which month in SampleData has the most rainy days?
```

The pattern holds for every source you connect. Add Salesforce, Google Sheets, or Jira and the same agent
queries it through the same server without being reconfigured. See [Sources](/en/Sources).

One endpoint exposes every source on your account, so this gets more useful as you add sources. An agent
discovers them all through `getCatalogs`, which means one conversation can reach Salesforce, HubSpot, and
Jira together without any per-source setup:

```text wrap theme={null}
Using the connectai MCP server, list my top 10 open Salesforce opportunities by amount, then check HubSpot for the most recent marketing activity on each of those accounts.
```

<Frame>
  <img alt="An agent listing the data sources available through one Connect AI MCP endpoint" />
</Frame>

The agent runs one query per source and correlates the results. Because both sources are reached
through the same endpoint with the same permissions, no per-source credentials or connector code are
involved.

## Use the Connection From Other Tools

One connection serves every consumer, with the same permissions applied to each. The same data is
available via MCP, [REST](/en/API/REST-API), [OData](/en/API/OData-Dashboard), and the
[Virtual SQL Server](/en/SQL-Server) endpoint at once, with no source-specific code between them. REST and
OData authenticate with a [personal access token](/en/Settings/Personal-Access-Tokens), and OData also
needs a [workspace](/en/Workspaces). See [API](/en/API/API) for the complete API reference.

BI tools read the connection you made in Step 3 through those endpoints, so there is nothing new to set up
on the Connect AI side. Start with
[Power BI Desktop](/en/Clients/PowerBIDesktop-Client), [Excel](/en/Clients/Excel365-Client), or
[Tableau Desktop](/en/Clients/TableauDesktop-Client), or see [Integrations](/en/Integrations) for the
rest.

## Next Steps

Your data is connected and queryable from agents, APIs, and BI tools. These are what people usually
reach for next.

### Get More Out of the Connection

* [Add another data source](/en/Sources)—Agents and BI tools pick up new connections without being
  reconfigured, and you can then query across sources.
* [Explore and model in the browser](/en/Data-Explorer)—Data Explorer runs SQL against a connection
  directly, which is the fastest way to see what a source exposes or confirm an answer the agent gave you.
  Save a query as a [derived view](/en/Data-Explorer#configure-derived-views) and agents read it like a
  table.
* [See what ran](/en/Logs)—The Query Log records every query with its full text, which is the fastest way
  to trace an unexpected result or an unexpected bill from a source API.
* [Make the connection read-only](/en/API/MCP)—Add `?ops=` to the server URL so an agent can query your
  data but cannot change it.
* [Ask questions without an agent](/en/Playground)—Playground answers natural-language questions about
  your connected data from inside Connect AI, with no client to configure.
* [Reach data behind your firewall](/en/Connect-Gateway)—Connect Gateway is a reverse tunnel you run as a
  Docker container or on Kubernetes, so Connect AI can query data in a private network or VPC without
  exposing it to the internet.

### Control Access

* [Permissions](/en/Permissions)—Grant SELECT, INSERT, and EXECUTE access by need-to-know at the source or
  workspace level, and choose whether each source uses a shared service account or per-user
  authentication, so an agent sees only what the person driving it is allowed to see.
* [Workspaces](/en/Workspaces)—Group sources and derived views, and share them with teams.
* [Data Security](/en/Data-Security)—Data masking rules tagged to regulations such as HIPAA, PCI DSS, and
  CCPA, plus rate limits, IP allowlists, and audit logging.
* [Security and compliance](/en/Security)—How Connect AI handles PII, and the frameworks it maintains,
  including SOC 2 Type II, ISO, and GDPR.
* [Toolkits](/en/Toolkits)—Expose only the tables and operations an agent needs. Check the prerequisites
  on that page first: Toolkits have both a plan and a role requirement.

## Get Help

* [Status page](https://status.cdata.com/)—current status and incident history for the application services.
* [CData Technical Support](https://www.cdata.com/support/submit.aspx)—also reachable from the **Support** link at the bottom of the dashboard.
* [Release Notes](/en/ReleaseNotes)—new connectors, enhancements, and fixes.


# Roles
Source: https://docs.cloud.cdata.com/en/Roles

The **Roles** tab on the ***Users*** page enables you to manage system roles and access roles on your Connect AI account.

A **Role** defines the user's privileges and permissions.

<Note>
  In Connect AI, privileges are administrative actions, while permissions are data and execution
  access.
</Note>

The following system roles are available:

* **Administrator** has full access to all Connect AI functions, including adding and managing users.
* **Connection Administrator** can create, edit, and delete connections and workspaces. They can also assign connection and workspace permissions, view users, query all connections, and view connection-related audit log events.
* **User Administrator** can create, invite, edit, and disable users, assign and revoke the **User Administrator** and **Query** roles, and view user-related audit events.
* **Query** users can authenticate to a connection with their own credentials, as long as the user and connection meet the following criteria:

  * An Administrator or Connection Administrator grants the user permission to use the connection.
  * An Administrator selects **Per-User Authentication**, rather than **Shared Authentication**, for the connection.

  The query user can also issue queries to connections they have access to through the [Data Explorer](/en/Data-Explorer) page and through [integration tools](/en/Integrations). This role also allows viewing personal query logs.

Every account must have at least one active Administrator.

See [Permissions and Access Control](/en/Permissions) for more information about the scope of these roles.

<Note>
  By default, all CData Connect Spreadsheets users have an Administrator role. They have full
  Select, Insert, Update, Delete, and Execute permissions.
</Note>

The **Roles** tab contains information about every role in Connect AI. Roles consist of predefined **system roles** and **access roles**:

* A **system role** (Administrator, Connection Administrator, User Administrator, or Query) defines what a user can do across the platform (managing connections, users, and running queries), and every user has exactly one.
* An **access role** is an optional, admin-defined set of data and workspace permissions assigned on top of the system role; access roles are additive, so a user can hold several.

<Frame>
  <img alt="Roles list" />
</Frame>

It contains the following information:

* A row for every role in your account:
  * **Role** is the role name.
  * **Privileges & Permissions** is a short overview of the scope of the role.
  * Edit and delete icons for the role. System roles cannot be deleted.

## Add an Access Role

<Steps>
  <Step>
    In the **Roles** tab of the **Users** page, click **Add Role** to open the **Add Role** page.

    <Frame>
      <img alt="Add a Role" />
    </Frame>
  </Step>

  <Step>Enter the **Role Name**.</Step>
  <Step>Enter a short description of the role that will appear on the **Roles** list.</Step>

  <Step>
    In the **Entities** tab, select the appropriate permissions for entities (data connections and
    workspaces) in your Connect AI instance. For more information about permissions, see
    [Permissions and Access Control](/en/Permissions).
  </Step>

  <Step>
    In the **Users** tab, click **Assign Users** to assign multiple users to the same access role.

    <Note>
      You can also add permissions to a user on an individual basis. These permissions are added to
      the role-based permissions.
    </Note>
  </Step>

  <Step>Select one or more users to assign to the role, and click **Confirm**.</Step>
  <Step>Click **Save Changes** to save the role.</Step>
</Steps>

## Edit a Role

You can modify any role or delete an access role at any time by clicking the edit or delete icons in the **Roles** list.

<Frame>
  <img alt="Edit a Role" />
</Frame>

In the **Edit Role** page, you can do the following:

* Edit the **Role Name** and **Description** fields (access roles only).
* Edit the permissions for the role.
* Assign or delete the users assigned to the role.
* Delete the entire role (access roles only).


# Service Accounts
Source: https://docs.cloud.cdata.com/en/Service-Accounts

The **Service Accounts** tab on the ***Users*** page enables you to manage non-human identities on your Connect AI account.

A **Service Account** is a non-human identity, such as an agent, that is authorized to interact with Connect AI. Service accounts authenticate via OAuth 2.0 Client Credentials. Use them to grant programmatic access to scripts, jobs, and external services.

<Frame>
  <img alt="Service Accounts" />
</Frame>

The **Service Accounts** tab contains the following information:

* A row for every service account in your account:
  * **Name** is the service account name.
  * **Client Id** is the unique identifier used to authenticate the service account via OAuth 2.0 Client Credentials.
  * **Status** is the status of the service account (active or inactive). If you deactivate a service account, any services or automations using these credentials will fail on the next request. The service account remains in the registry for audit purposes.
  * **Created** is the date and time the service account was created.
  * Rotate, edit, and delete icons for the service account. When you rotate credentials, the current credentials stop working immediately. You must update dependent services before the next request.

## Add a Service Account

<Steps>
  <Step>
    In the **Service Accounts** tab of the **Users** page, click **Add Account** to open the **Add
    Service Account** page.

    <Frame>
      <img alt="Add a Service Account" />
    </Frame>
  </Step>

  <Step>Enter the **Name** of the service account.</Step>
  <Step>Enter a short **Description** of the service account.</Step>

  <Step>
    Select an **Authentication Type** of **Client Secret** or **Public Key**. If you select **Public
    Key**, you are asked to upload the public key (PEM) file (RS256 or ES256).
  </Step>

  <Step>Click **Confirm** to save the service account.</Step>

  <Step>
    If you selected **Client Secret**, an **Add Service Account** dialog appears. Copy the
    **Client Id** and **Client Secret**. The **Client Secret** only appears once.

    <Note>
      Share these credentials with the developer who will authenticate the service account using OAuth 2.0. See
      [Service Account Setup](/en/API/Service-Account-Setup) for details.
    </Note>
  </Step>

  <Step>
    Click **Done**. An **Edit Service Account** page appears.

    <Frame>
      <img alt="Edit a Service Account" />
    </Frame>
  </Step>

  <Step>
    (Optional) Add an **Access Role** to the service account. Selecting an access role automatically
    updates the **Permissions** to the entities below.
  </Step>

  <Step>
    (Optional) In **Permissions**, manually select the service account's permissions to entities
    (data connections and workspaces) in your Connect AI instance. For more information about
    permissions, see [Permissions and Access Control](/en/Permissions).
  </Step>
</Steps>

## Edit a Service Account

You can modify any service account, rotate credentials, or delete a service account at any time by clicking the rotate, edit, or delete icons in the **Service Accounts** list.

In the **Edit Service Account** page, you can do the following:

* Edit the **Name** and **Description** fields.
* Add and remove access roles.
* Manually update permissions.
* Rotate credentials (the current credentials will stop working immediately).
* Delete the entire service account.


# Settings
Source: https://docs.cloud.cdata.com/en/Settings

You can access your *Settings* page by clicking the Gear Icon in the upper-right corner of the dashboard and selecting **Settings**.

<Frame>
  <img alt="Access settings" />
</Frame>

The Settings page contains the following tabs (depending on your Connect AI plan):

* [**Profile**](/en/Settings/Profile): The profile settings for the current user.
* [**Account**](/en/Settings/Account): Account-wide settings for Connect AI.
* [**Security**](/en/Settings/Security): Security settings that are applied globally.
* [**Personal Access Tokens**](/en/Settings/Personal-Access-Tokens): Create and manage personal access tokens (PATs) for authentication.
* [**OAuth Apps**](/en/Settings/OAuthApps): Generate custom OAuth applications for client applications.
* [**Keys**](/en/Settings/Keys): Create and manage key vaults.
* [**SIEM Endpoints**](/en/Settings/Siem-Endpoints): Configure SIEM endpoints to forward to your SIEM systems.
* [**Billing**](/en/Settings/Billing): Information about your account plan and usage.

Refer to these pages for more information.


# Account
Source: https://docs.cloud.cdata.com/en/Settings/Account

The Account tab provides access to account-wide settings.

The **Account** tab provides access to account-wide settings.

<Frame>
  <img alt="Settings account" />
</Frame>

The sections of this page are described below.

## Details

The **Details** section lists the following global account information:

* Organization Name
* Account Id
* Country

## Primary Contact Information

This section contains the following fields that define the account's primary contact for invoices, announcements, and other communication. These fields can only be edited by administrators.

* First name
* Last name
* Email
* Phone Number
* Country

<Note>
  The email in this section is not the user login email. Change the login email in the **Profile** tab.
</Note>

## Delete Account

If you want to delete your Connect AI account and all of its data, click **Contact Sales** for assistance.

<Note>
  Account deletion is permanent. If you delete your account and later want to use Connect AI again, you must create a new account.
</Note>


# Billing
Source: https://docs.cloud.cdata.com/en/Settings/Billing

The Billing tab provides information and controls for your account plan and usage.

The **Billing** tab provides information and controls for your account plan and usage.

<Frame>
  <img alt="Settings billing" />
</Frame>

This tab consists of the following:

* The **Billing** section displays your plan information and next billing date.
  * Click **Manage Payment Method** to open your account with Stripe. You can manage your billing settings, such as your payment method and billing address. If your subscription has lapsed, you must reactivate your plan to continue using Connect AI.
  * The **Update Plan** section on the right (if applicable) contains information about contacting the Connect AI sales team. You can also email [sales@cdata.com](mailto:sales@cdata.com).
  * If you are on a free trial account, this section displays your trial information.
* The **Additional Usage** section displays what is remaining in your current plan.


# Keys
Source: https://docs.cloud.cdata.com/en/Settings/Keys

Store data source authentication information in key vaults.

Connect AI supports storing data source authentication information in key vaults. Instead of entering authentication information directly in the **Add Connection** page for your data source, you enter the name of the key vault. You can then update the information in the key vault without affecting your data connection.

<Note>
  * Currently supports Azure Key Vault. Support for additional key vault providers is planned.
  * Available for Business tier in Connect AI only.
  * Not available for Connect AI Embed.
</Note>

## Azure Key Vault Prerequisites

Before configuring Connect AI, complete the following steps in the Azure Portal.

### Create an Azure Key Vault

<Steps>
  <Step>
    In the [Azure Portal](https://portal.azure.com), search for **Key vaults** and click **Create**.
  </Step>

  <Step>
    Select your **Subscription**, **Resource group**, **Key vault name**, and **Region**.
  </Step>

  <Step>
    Click **Review + create**.
  </Step>

  <Step>
    After the vault is created, open it and note the **Vault URI** from the **Overview** page. It follows the pattern `https://<vault-name>.vault.azure.net/`.

    <Frame>
      <img alt="Key Vault URI" />
    </Frame>
  </Step>
</Steps>

### Register an Application in Microsoft Entra ID

Connect AI authenticates to your key vault using a registered application (service principal).

<Steps>
  <Step>
    In the Azure Portal, navigate to **Microsoft Entra ID** > **Manage** > **App registrations** > **New registration**.
  </Step>

  <Step>
    Enter a **Name** for the application and click **Register**.
  </Step>

  <Step>
    On the app's **Overview** page, note the **Application (client) ID** and the **Directory (tenant) ID**.

    <Frame>
      <img alt="Application and Directory ID" />
    </Frame>
  </Step>

  <Step>
    Go to **Manage** > **Certificates & secrets** > **New client secret**. Enter a description, select an expiration, and click **Add**.
  </Step>

  <Step>
    Copy the secret **Value** immediately. It is not shown again after you leave the page.

    <Frame>
      <img alt="Certificates and secrets" />
    </Frame>
  </Step>
</Steps>

### Grant the Application Access to the Key Vault

<Steps>
  <Step>
    Open your key vault in the Azure Portal and go to **Access policies** > **Create**.

    <Frame>
      <img alt="Access policies" />
    </Frame>
  </Step>

  <Step>
    Under **Secret permissions**, select **Get** and **List**.
  </Step>

  <Step>
    Under **Principal**, search for and select the application you registered, then click **Next**.
  </Step>

  <Step>
    Click **Next** through the **Application** tab (no changes required).
  </Step>

  <Step>
    Review the policy and click **Create**. This allows Connect AI to read secrets from the vault.
  </Step>

  <Step>
    Back on the **Access policies** page, verify that your access policy is listed.
  </Step>
</Steps>

## Create a New Key Vault

<Steps>
  <Step>
    Click **+ Add Vault**. The **Add Azure Key Vault** dialog appears.

    <Frame>
      <img alt="Add Azure key vault" />
    </Frame>
  </Step>

  <Step>
    Enter a **Vault Name** to identify this vault in Connect AI. This does not have to match the Azure vault name.
  </Step>

  <Step>
    Enter the **Vault URI**. This is the URI from the **Overview** page of your key vault in the Azure Portal (for example, *[https://my-vault.vault.azure.net/](https://my-vault.vault.azure.net/)*). This is in the Create an Azure Key Vault step of the prerequisites.
  </Step>

  <Step>
    Enter the **Application Id**, also known as the **Client Id**. This is the **Application (client) ID** from the **Overview** page of your app registration in Microsoft Entra ID (In the Register an Application in Microsoft Entra ID step in the prerequisites).
  </Step>

  <Step>
    Paste the **Client Secret** value you copied when you registered the application in Microsoft Entra ID (in the Register an Application in Microsoft Entra ID step in the prerequisites).
  </Step>

  <Step>
    Enter the **Directory Id**, also known as the **Tenant Id**. This is the **Directory (tenant) ID** from the **Overview** page of your app registration in Microsoft Entra ID (in the Register an Application in Microsoft Entra ID step in the prerequisites)
  </Step>

  <Step>
    Click **Confirm** to save your credentials. If successfully saved, the new key vault appears in the list of key vaults, along with the **Key Vault URL** and **Creation Date**.
  </Step>
</Steps>

Once you create a new key vault, you can use the key vault as a credential for data source connections.

## Delete a Key Vault

To delete a key vault that you no longer use, click the delete icon in the key vault list.


# OAuth Apps
Source: https://docs.cloud.cdata.com/en/Settings/OAuthApps

Generate custom OAuth applications for client integrations.

The **OAuth Apps** tab allows you to generate a custom OAuth application for client integrations. It contains a list of available OAuth apps, including their application type and creation date.

<Frame>
  <img alt="Settings OAuth" />
</Frame>

## Create a Custom OAuth Application

To create a custom OAuth application:

<Steps>
  <Step>
    Click **+ Create App**. The **Create OAuth App** dialog appears.

    <Frame>
      <img alt="Create OAuth App" />
    </Frame>
  </Step>

  <Step>
    Enter the **Name** of the OAuth app.
  </Step>

  <Step>
    Select the **Application Type** for your OAuth application.

    <Note>For service and automated applications, use [Service Accounts](/en/Service-Accounts) instead.</Note>

    * **Web Application**–select this option for service-side apps with a client secret Authorization Code grant. A client secret is required.
    * **Single Page App**–select this option for browser-based Authorization Code + PKCE grant. No client secret is required.
    * **CLI/Local Agent**–select this option for command-line tools. No client secret is required.
  </Step>

  <Step>
    Go to your client application and create a new application registration there. The client application will provide a callback URL.
  </Step>

  <Step>
    Return to the **Create OAuth App** dialog in Connect AI and paste the **Callback URL** from the client application. This URL redirects users after login. You can provide up to 10 callback URLs for your OAuth app.
  </Step>

  <Step>
    Click **Confirm**. Connect AI creates the OAuth app and generates a **Client Id** and **Client Secret** for the client application. Copy these values.

    <Frame>
      <img alt="OAuth App Client Id and Secret" />
    </Frame>
  </Step>

  <Step>
    Return to the client application and paste the **Client Id** and **Client Secret** in the appropriate fields. For example, in Gemini Enterprise:

    <Frame>
      <img alt="Client Id and Client Secret" />
    </Frame>
  </Step>

  <Step>
    The new OAuth app appears in the list of apps. Click the edit icon (<Icon icon="pencil" />) to edit the app and add more callback URLs for other client applications, if needed.
  </Step>
</Steps>

Your external system might ask for information about the CData authorization, token, and registration URLs. They are as follows:

| Endpoint | Value |
| :- | :- |
| **Authorization URL** | [https://cloud-login.cdata.com/authorize](https://cloud-login.cdata.com/authorize) |
| **Token URL** | [https://cloud-login.cdata.com/oauth/token](https://cloud-login.cdata.com/oauth/token) |
| **Registration URL** | [https://mcp.cloud.cdata.com/register](https://mcp.cloud.cdata.com/register) |
| **Authorization server base** | [https://mcp.cloud.cdata.com](https://mcp.cloud.cdata.com) |
| **Resource** | [https://mcp.cloud.cdata.com/mcp](https://mcp.cloud.cdata.com/mcp) |


# Personal Access Tokens
Source: https://docs.cloud.cdata.com/en/Settings/Personal-Access-Tokens

Create and manage personal access tokens (PATs) for authenticating with the REST API, OData, and Virtual SQL Server.

Personal access tokens (PATs) are used when you connect to your data through the [REST API](/en/API/REST-API), the [OData protocol](/en/Data-Sources/OData), or the [Virtual SQL Server](/en/SQL-Server). You can create and manage your PATs on this tab.

<Frame>
  <img alt="Settings PAT" />
</Frame>

## Create a PAT

Follow these steps to create a new PAT:

<Steps>
  <Step>
    Click **Create PAT**.
  </Step>

  <Step>
    Enter a name for the PAT in the dialog that appears. It might be useful to enter a name that indicates its purpose.
  </Step>

  <Step>
    Click **Create** and a new dialog appears.
  </Step>

  <Step>
    Click the copy icon in that dialog to copy the PAT to your clipboard. The icon is to the right of the token field.
    <Note>You cannot view the PAT again after you close this dialog.</Note>

    <Frame>
      <img alt="PAT created" />
    </Frame>
  </Step>

  <Step>
    Click **Close** to close the dialog. The new PAT appears in the list and includes its **Creation Date** and **Expiration Date**.

    <Note>
      The PAT expiration date is set globally in the **Security** tab.
    </Note>
  </Step>
</Steps>

## Regenerate a PAT

To regenerate a PAT, click the regeneration icon in the PAT list and follow the prompts.

<Frame>
  <img alt="Regenerate PAT" />
</Frame>

<Note>
  Regenerating a PAT revokes access for any applications that use the PAT. Therefore, you must enter the newly generated PAT in any such applications.
</Note>

## Delete a PAT

To delete a PAT that you no longer use, click the delete icon in the PAT list.

<Frame>
  <img alt="Delete PAT" />
</Frame>

Click **Confirm** in the confirmation dialog that is displayed.

<Note>
  Deleting a PAT revokes access for any applications that use the PAT. Therefore, you must create a new PAT and enter it into those applications to restore this access.
</Note>


# Profile
Source: https://docs.cloud.cdata.com/en/Settings/Profile

The Profile tab contains settings for the account you are currently signed in with.

The **Profile** tab opens by default when you access Settings. This tab contains settings for the account you are currently signed in with.

<Frame>
  <img alt="Settings profile" />
</Frame>

In the **User Profile** section, you can edit the first name and last name for the current user. Your user role appears in the **Role** text box, but it cannot be edited on this page. See [Roles](/en/Roles) for more information about roles.

You can change the email that you use to log in by entering the new email and clicking **Save Changes**. If you want to reset your password, click **Reset Password**. This action sends a password reset email to the email address that appears in **Email**.

<Note>If you are an SSO user, you must contact the administrator in your organization to change your email and/or password.</Note>

In the **Grant Support Access** section, administrators can toggle support access on so that the CData support team can log in and help troubleshoot issues for the users in the administrator's account. Administrators can revoke access at any time by disabling this setting.

Click **Save Changes** to save the selection. Then click **Accept** in the **Grant Support Access** dialog to agree to the terms and conditions of granting support access.

<Note>This feature is enabled for administrators only. Query users can contact their administrator to grant support access to their accounts.</Note>


# Security
Source: https://docs.cloud.cdata.com/en/Settings/Security

The Security tab contains security settings that are applied globally.

The security settings on this tab are applied globally.

<Frame>
  <img alt="Settings security" />
</Frame>

## Personal Access Token Expiration

This section allows you to set a global Personal Access Token (PAT) expiration (such as **30 Days**, **60 Days**, or **Never Expire**). Shorter durations improve security. When the PAT expires, the PAT displays **Expired** in the **Security** tab of **Settings**, and any authentication using the PAT fails with an `"Invalid personal access token"` error.

To create a PAT, see [Personal Access Tokens](/en/Settings/Personal-Access-Tokens).

## Default Connection & Workspace Permissions

From the drop-down list, select the default permissions granted to new users for all connections and workspaces. Options include **No Permissions** to connections and workspaces by default or **Select Only** permissions to connections and workspaces by default.

<Note>This setting does not affect the connection and workspace access of existing users.</Note>

## Playground Access

Toggle this feature off if you do not want your users to have access to [Playground](/en/Playground).

## MCP Connectivity

Toggle this feature off if you do not want your users to have access to any MCP-related functionality.

## SSO

**Just-in-Time (JIT) User Provisioning** automatically provisions new users the first time they sign in to an SSO-enabled domain.

<Frame>
  <img alt="Settings SSO" />
</Frame>

To enable JIT user provisioning:

<Steps>
  <Step>
    Enable the toggle for a domain to turn on JIT provisioning.
  </Step>

  <Step>
    Select the **JIT User Role** for new JIT users.
  </Step>

  <Step>
    Select the **JIT Access Role** for new JIT users.
  </Step>

  <Step>
    Click **Save Changes**.
  </Step>
</Steps>

See [JIT User Provisioning](/en/SCIM/SSO) for more information about JIT. See [Roles](/en/Roles) for more information about user roles and access roles.


# SIEM Endpoints
Source: https://docs.cloud.cdata.com/en/Settings/Siem-Endpoints

Configure SIEM endpoints to forward audit log events to your security information and event management system.

Security Information and Event Management (SIEM) systems, such as Datadog, collect and analyze security-related event data from across your infrastructure. The **SIEM Endpoints** tab allows you to configure endpoints so that Connect AI forwards such audit log events as user logins, query activity, and connection changes to your SIEM platform in real time. This enables your security team to monitor Connect AI activity alongside other enterprise systems for threat detection, compliance reporting, and incident response.

<Note>
  * Available for Business tier in Connect AI only.
  * Not available for Connect AI Embed.
  * Connect AI uses a range of static IP addresses to communicate with external data sources. To ensure that you can access your data, you must allow these static IP addresses in your data sources. The table below lists these IP addresses.

    | IP Addresses (CIDR) | IP Addresses (Range) |
    | :- | :- |
    | 52.224.0.160/28 | 52.224.0.160 - 52.224.0.175 |
    | 4.154.117.160/28 | 4.154.117.160 - 4.154.117.175 |
</Note>

The **SIEM Endpoints** tab contains a list of configured SIEM endpoints, including the **Name**, **Endpoint URI**, and **Status** of each endpoint. The status can be **Active** (the endpoint is receiving events normally), **Failed** (the last delivery attempt failed), or **Pushing** (an event batch is currently being transmitted).

<Frame>
  <img alt="SIEM Endpoints" />
</Frame>

<Note>Only Administrators can view, modify, or delete SIEM endpoints.</Note>

## Add a Datadog Logs API Endpoint

<Steps>
  <Step>
    In the **SIEM Endpoints** tab, click **+ Add Endpoint**. The **Add Endpoint** dialog appears.
  </Step>

  <Step>
    Select **Datadog Logs API**.
  </Step>

  <Step>
    Enter a user-defined **Endpoint Name**.
  </Step>

  <Step>
    Under **Configuration Settings**, configure the following:

    * **Region**–(optional) select the region for your Datadog account.
    * **DD-API-KEY**–enter the Datadog API key used to authenticate the connection. Find your key in Datadog under **Organization Settings** > **API Keys**.
    * **Endpoint URL**–autogenerated based on the selected region.
    * **Service Tag**–(optional) enter a user-defined tag to identify the events forwarded to your Datadog account, such as *audit-all-events*. In Datadog, you can search by this tag.
  </Step>

  <Step>
    Under **Delivery Settings**, configure the following:

    * **Event Scope**–select which events are forwarded to the endpoint. Options include **All Events**. Coming soon: Support for specific events, such as **Control Plane** events.
    * **Batch Size (Events)**–enter the maximum number of events to include in each batch.
    * **Batch Size (Time-based)**–enter the maximum time interval (in seconds) before a batch is sent, even if the event limit has not been reached.
    * **Delayed Event Alert Threshold**–enter the number of delayed events after which Connect AI sends an email alert to account administrators.
    * **Alert Recipient Email**–enter the email address of the alert recipient, which can be a shared inbox. By default, this field is populated with your email address.
    * **GZIP Compression**–toggle on or off to control whether event data is compressed before transmission.
  </Step>

  <Step>
    Click **Save**. Connect AI tests the connection immediately. If the test succeeds, the endpoint is added to the list. If the test fails, an error message appears; check your configuration and try again.
  </Step>
</Steps>

## Add a Splunk HEC Endpoint

Connect AI delivers query and audit log events to Splunk's HTTP Event Collector (HEC) in OCSF (Open Cybersecurity Schema Framework) format. Setting up Splunk HEC involves three steps: creating an HEC token in Splunk, adding the endpoint in Connect AI, and installing the Splunk add-ons that let Splunk interpret OCSF events.

### Create an HEC Token in Splunk

<Note>
  * Connect AI verifies the TLS certificate your HEC endpoint presents on every request. The certificate must be issued by a public certificate authority and must match the hostname you enter. Self-signed certificates and certificates from an internal authority are refused.
  * Splunk Cloud free trials cannot be used with Connect AI. A trial stack presents a self-signed default certificate, and the `http-inputs-` address that carries a valid certificate is only provisioned for managed Splunk Cloud. To evaluate this integration, you need a managed Splunk Cloud stack or a self-hosted Splunk instance with a certificate from a public certificate authority.
</Note>

<Steps>
  <Step>
    If you want Connect AI events in a dedicated Splunk index, create that index in Splunk before you create the token. The token's index is set at creation time from the list of existing indexes. Connect AI does not override the token's index, so this is your only opportunity to control where events land without recreating the token.

    If you create a new index and later cannot find events, check that your Splunk role covers that index before assuming delivery failed.
  </Step>

  <Step>
    In Splunk, go to **Settings** > **Data Inputs** > **HTTP Event Collector** and click **New Token**.
  </Step>

  <Step>
    Complete the token setup wizard. When prompted, select the index you created, or accept the default.

    <Warning>
      Indexer acknowledgement must be disabled. Splunk requires a channel identifier on every request to a token that has acknowledgement enabled. Connect AI does not send a channel identifier, so with acknowledgement on, none of the events Connect AI sends are indexed. If this setting is enabled when you save the endpoint, Connect AI returns an error identifying the setting. The acknowledgement setting cannot be changed after a token is created; you must create a new token with acknowledgement disabled and update the **HEC Token** in Connect AI.
    </Warning>
  </Step>

  <Step>
    On the confirmation page, copy the **Token Value**. Paste it into Connect AI as the **HEC Token**. Splunk does not display the token value again after you leave this page.
  </Step>

  <Step>
    Note your collector address. The format differs by deployment type:

    * **Splunk Enterprise:** `https://<your-splunk-host>:8088`. The port `8088` is the default but can be changed by an administrator; it is never the same port as the Splunk web console.
    * **Splunk Cloud Platform:** `https://http-inputs-<your-stack>.splunkcloud.com:443`. The `http-inputs-` prefix is required. On Google Cloud and Azure stacks, the prefix is `http-inputs.` (with a dot instead of a hyphen).

    You do not need to include the `/services/collector/event` path; Connect AI appends it automatically.
  </Step>
</Steps>

### Add the Endpoint in Connect AI

<Steps>
  <Step>
    In the **SIEM Endpoints** tab, click **+ Add Endpoint**. The **Add Endpoint** dialog appears.
  </Step>

  <Step>
    Select **Splunk HEC**.
  </Step>

  <Step>
    Enter a user-defined **Endpoint Name**.
  </Step>

  <Step>
    Under **Configuration Settings**, configure the following:

    * **HEC Endpoint URL**–enter the collector address from your Splunk instance, including the port (for example, *[https://splunk.example.com:8088](https://splunk.example.com:8088)* for Splunk Enterprise, *[https://http-inputs-mystack.splunkcloud.com:443](https://http-inputs-mystack.splunkcloud.com:443)* for Splunk Cloud, or *[https://http-inputs.mystack.splunkcloud.com:443](https://http-inputs.mystack.splunkcloud.com:443)* for Splunk Cloud on Google Cloud or Azure). Connect AI appends the collector path automatically. You can also paste a full collector URL. To deliver to multiple indexers, enter up to ten addresses separated by commas.
    * **HEC Token**–enter the token value from your Splunk HEC setup.
    * **Source**–(optional) enter a label to identify events from this endpoint in Splunk. Delivered events carry this value as their Splunk source. If left blank, Connect AI uses the endpoint name.
    * **Sourcetype**–read-only. Displays the fixed value `ocsf:cdata:connect`, which you will enter in Splunk's OCSF add-on. See [Make Events Usable in Splunk](#make-events-usable-in-splunk) for details.
  </Step>

  <Step>
    Under **Delivery Settings**, configure the following:

    * **Event Scope**–select which events are forwarded to the endpoint. Options include **All Events**. Coming soon: Support for specific events, such as **Control Plane** events.
    * **Batch Size (Events)**–enter the maximum number of events to include in each batch.
    * **Batch Size (Time-based)**–enter the maximum time interval (in seconds) before a batch is sent, even if the event limit has not been reached.
    * **Delayed Event Alert Threshold**–enter the number of delayed events after which Connect AI sends an email alert to account administrators.
    * **Alert Recipient Email**–enter the email address of the alert recipient, which can be a shared inbox. By default, this field is populated with your email address.
    * **GZIP Compression**–toggle on or off to control whether event data is compressed before transmission.
  </Step>

  <Step>
    Click **Save**. Connect AI validates the address on every save (HTTPS, reachable from the public internet, publicly trusted certificate). Token validation occurs when you enable the endpoint: enabling sends a single test event and refuses to save if Splunk rejects it, identifying the address that failed. A disabled endpoint can be saved without this test; errors surface when you switch it on. If you entered multiple indexer addresses, testing stops at the first failure. Fix the address named in the error and save again to check the rest.
  </Step>
</Steps>

<Note>
  The endpoint is now configured. To make events usable in Splunk dashboards and Enterprise Security detections, continue to the next section, Make Events Usable in Splunk. This is a required step.
</Note>

## Make Events Usable in Splunk

Without this step, Connect AI events are searchable text only: no dashboards, no Enterprise Security detections, and no correlation with other sources. Two Splunk add-ons and one configuration value teach Splunk how to interpret the OCSF events Connect AI sends.

You must have Splunk administrator access for this step.

<Steps>
  <Step>
    Install the **Splunk Common Information Model (CIM) Add-on** from Splunkbase. The OCSF add-on maps events into CIM data model fields, so the CIM add-on must be installed first.
  </Step>

  <Step>
    Install the **Splunk Add-on for OCSF** from Splunkbase.
  </Step>

  <Step>
    In the OCSF add-on setup, enter the sourcetype that Connect AI sends: `ocsf:cdata:connect`.

    Copy this value from the endpoint's page in Connect AI; it is displayed there for this purpose. Connect AI always sends this sourcetype and it cannot be changed. The add-on matches against the `ocsf:*` pattern to normalize events. A different value stops normalization, leaving events that arrive but never populate dashboards or detections.
  </Step>

  <Step>
    Accelerate the following data models in Splunk so that Enterprise Security searches and dashboards include Connect AI events: **All\_Changes**, **Authentication**, and **Alerts**.

    <Note>If events arrive and are searchable but nothing appears in dashboards or detections, check the sourcetype configured in the previous step; this is the most common cause.</Note>
  </Step>
</Steps>

## What Connect AI Sends

Connect AI sends query and audit log events in OCSF 1.3.0 format. Four OCSF classes are used:

| OCSF Class | What It Covers in Connect AI | CIM Data Model |
| :- | :- | :- |
| API Activity (6003) | Platform create, read, update, and delete operations: connections, workspaces, users, and queries | `All_Changes` |
| Account Change (3001) | Identity and access changes: accounts, roles, and permissions | `All_Changes.Account_Management` |
| Authentication (3002) | Sign-in activity, including failed service-account authentication | `Authentication` |
| Data Security Finding (2006) | PII detected in data passing through the platform (warned, redacted, or blocked) | `Alerts` |

All four classes normalize through the CIM and OCSF add-ons; no class requires special handling.

## Splunk HEC Delivery Behavior

Events are delivered continuously as they are audited.

* **No filtering:** Every query and audit log event your account generates is sent.
* **OCSF only:** OCSF is the only supported format.
* **Pause and resume:** Disabling an endpoint pauses delivery and holds its position. Re-enabling resumes from where it stopped. Events are held for a limited window while paused; a long pause can lose the oldest events.
* **Delivery-failure alerts:** If delivery starts failing, Connect AI sends a delivery-failure alert to the address configured on the endpoint.
* **Event timestamps:** Every event carries the time the audited action occurred, not the delivery time. A delayed or replayed batch still reports correctly in Splunk.

## Edit a SIEM Endpoint

To edit a SIEM endpoint, click the edit icon in the endpoint list, make your changes, and click **Save**.

## Delete a SIEM Endpoint

To delete a SIEM endpoint that you no longer use, click the delete icon in the endpoint list. Click **Confirm** in the confirmation dialog that is displayed.

## Push History

Click the edit icon in the endpoint list to view the push history of an endpoint. The **Push History** section of the **Edit SIEM Endpoint** page displays delivery status information for each endpoint.

<Frame>
  <img alt="SIEM push history" />
</Frame>

* **Last Push**–the date and time of the most recent event batch sent to the endpoint.
* **Retry Count**–the number of times Connect AI has retried delivery after a failed push.
* **Status**–the current delivery status of the endpoint (**Active**, **Failed**, or **Pushing**). Click the status, such as **Failed**, to view details.

  <Note>The failed status may be the result of expired credentials. Update your credentials and save. For Splunk HEC endpoints, re-enabling the endpoint sends a test event to confirm delivery.</Note>
* **Delayed Events**–the number of events that have not yet been delivered to the endpoint.

## View Events in Your SIEM Platform

### Datadog

In Datadog, you can search using the **Service Tag** you entered on the **SIEM Endpoint** page. The following example displays all events under the tag `cdata-audit-test-all-events`:

<Frame>
  <img alt="Datadog view" />
</Frame>

### Splunk

The amount of out-of-the-box content depends on which Splunk products you run:

* **Splunk Cloud or Splunk Enterprise**: You can search events and build dashboards from events, but there is no prebuilt security content. The add-ons normalize the data; they do not add dashboards.
* **Splunk Enterprise Security**: Prebuilt SIEM content is available. Enterprise Security is a separately licensed product; the detections that run depend on which data model an event lands in.

Two things to know about prebuilt content coverage:

* **Authentication is where prebuilt content is richest.** Sign-in activity, including failed service-account authentication, lands in the Authentication data model, which Enterprise Security ships substantial content against.
* **Most Connect AI events are API Activity**, which lands in `All_Changes`. Enterprise Security's prebuilt content for that data model is largely written for cloud infrastructure provisioning. Expect to write your own correlation searches for platform activity such as a connection being changed. The data is complete and normalized; the prebuilt detections are not aimed at it.

PII detections land in the Alerts data model, with the detection type as the alert signature. To search for them directly:

```spl theme={null}
index=<your index> sourcetype="ocsf:cdata:connect" class_uid=2006
```


# User Context
Source: https://docs.cloud.cdata.com/en/Settings/User-Context

The User Context tab allows you to add information about yourself that is sent to the LLM once at the beginning of each conversation.

The **User Context** tab provides information about you to the LLM. You can paste in a Markdown file. Click **Preview** to preview the file and click **Save** when you are done.

<Frame>
  <img alt="User Context" />
</Frame>

<Warning>Do not include passwords or API tokens in this field.</Warning>


# Sources
Source: https://docs.cloud.cdata.com/en/Sources

The ***Sources*** page enables you to create and manage connections to your data sources.

<Frame>
  <img alt="Sources" />
</Frame>

The **Sources** page contains the following information about each connection:

* **Connection Name** and **Data Source**—the user-defined name of the connection and the data source type of the connection. This column also contains an icon indicating that the data source supports custom reports.
* **Last Queried**—the last time a user queried the data.
* **Status**—The status of the connection, which can be one of the following:
  * **Authenticated**—the connection to the data source is successful.
  * **Not Authenticated**—the connection was created in Connect AI, but is not successfully connected to the data source. You can return to the connection's edit screen to authenticate the connection. Note that Query users need to contact an administrator to authenticate a connection.
  * **Conditional**—the connection is conditional based on the global settings and tables added to the connector. This occurs with the API connector.
* **Last Modified**—the date and time a user last modified the connection. Click the user icon next to the date and time to display the user who last modified the data.

## Add a Connection

To add a new connection, complete the following steps:

<Steps>
  <Step>
    On the **Sources** page, click **Add Connection**. This action displays the **Add Connection** dialog.
  </Step>

  <Step>
    Select a data source from the list in the dialog, or search for a connection by name.

    <Frame>
      <img alt="Add connection" />
    </Frame>
  </Step>
</Steps>

After you select a data source, the **Add Connection** page for your data source appears.

<Steps>
  <Step>
    Configure the connection according to the instructions for the data source. Setup instructions appear in the **Documentation** tab in the right pane of the configuration page. They are also available in this documentation—look for your data source in the **Data Sources** section, or use the search bar to find it.
  </Step>

  <Step>
    Click **Save and Test**.
  </Step>
</Steps>

If the connection succeeds, a **Connection successfully saved** message appears. You can also view the data model of your connection in the right pane of the **Edit Connection** page, in the **Data Model** tab. When you return to the main **Sources** page, the new connection appears in the Sources list. You can modify or delete a connection at any time by clicking the edit or delete icons in the list.

If the connection fails, error messages appear under the fields with missing data. Some data sources require that you sign in directly to the data source’s website. If you did not sign in, an error message appears under the **Sign in** button.

In some situations, refreshing your metadata cache for a connection can help fix loading or performance issues. To refresh the cache, click **Refresh Metadata** at the top of the **Edit Connection** page. A success banner confirms that the metadata cache has been refreshed. <Note>If you attempt to modify or delete a connection and Connect AI finds a cached job from the current connection, you are prompted with a warning. You can choose to cancel or continue with the changes. If you save the changes, Connect AI clears the cached data from the current connection.</Note>

If the connection fails, it is saved as a draft. A draft connection appears on the **Edit Connection** page and on the main **Sources** page as **Not Authenticated**. You can edit the connection later and finish the authentication process. <Note>Query users need to contact an administrator of the account to have a draft connection authenticated.</Note>

## Authentication Model

By default, all users on an account can access data from a data source through the same login credentials. For example, if you have a connection to Salesforce, all user accounts can access the data from the Salesforce account created for that Salesforce connection. Query permissions can be customized for each user to restrict available operations, but all users access the same data under these restrictions.

Certain data sources support the ability to force each user on an account to log in to a connection with their own login credentials. This feature ensures that users can only access the data from accounts that they need to access. Furthermore, when a connection is configured in this way, it only counts as a single connection slot toward your account maximum.

If a data source supports per-user authentication, an **Authentication Model** section appears under the **Authentication** section of the connection settings. Select either **Shared Authentication** or **Per-User Authentication**.

<Frame>
  <img alt="Authentication Model" />
</Frame>

If this feature is not available for a specific data source and you would like it, please contact our support team to request the feature.

<Note>
  The following restrictions apply to this feature:

  * Only administrator users can toggle a data source between shared authentication and per-user authentication, but users of all roles can log in to a per-user authentication connection with their own credentials.
  * Per-user authentication is not supported when using the [OData API](/en/API/OData-Dashboard). To connect a data source to the OData API, you must use shared authentication.
  * Caching is not permitted with per-user authentication (only shared authentication). See [Caching](/en/Caching) for details.
</Note>

## Log Verbosity

On the **Advanced Settings** tab for each connection, there is a setting in the **Logging** section labeled **Verbosity**. This value determines how much information Connect AI includes in the logs for that data source on the [Logs](/en/Logs) page.

The value for verbosity can range from 1 to 5, where 1 includes the smallest amount of information and 5 includes the largest amount of information. By default, each data source logs at verbosity level 2. Please note that higher verbosity levels negatively impact query performance. For maximum performance, be sure to only increase the verbosity level for troubleshooting purposes.

### Protecting Sensitive Information in Logs

Verbosity levels 3 and up include sensitive information from the connection, as outlined below:

* Level 3 includes the bodies of requests and responses to requests.
* Level 4 includes SSL certificates.
* Level 5 includes extra low-level transfer data not included at the previous levels.

<Note>
  Regardless of the verbosity level, sensitive connection properties—including passwords—are always masked in connection strings and any requests/responses.
</Note>

To ensure the security and safety of your sensitive information, be sure that you only increase logging verbosity when necessary. When logging verbosity is set to 3 or higher, be sure to open and review log files before sharing them outside of your organization.

## Assign Permissions

When you create or edit a connection, the **Permissions** tab displays a list of available users and allows you to assign permissions to each one. Permissions are described in the list below:

* **Select:** Enables you to select rows from tables in a connection.
* **Insert:** Enables you to insert rows into tables of a connection.
* **Update:** Enables you to update rows in tables of a connection.
* **Delete:** Enables you to delete rows from tables in a connection.
* **Execute:** Enables users to execute stored procedures in a connection.
  <Frame>
    <img alt="Connection permissions" />
  </Frame>

You can toggle the permissions in four ways:

* Click an individual box in the table to toggle that permission for a single user.
* Click the box at the top of a table column to toggle that permission for every user.

## Configure Custom Reports

Some data sources support *custom reports*, which allow you to configure pre-defined reports that you can query as views within your connections. Each report has a unique set of required inputs, and you provide these inputs when you configure the report in your Connect AI account.

Custom reports are generally useful in two types of scenarios:

* For ad or analytics data sources, they can be used to show aggregated reports on performance data by allowing you to pre-define a set of metrics and dimensions.
* Other types of data sources let you pre-define parameters to create data reports. For example, an accounting API might allow you to create a general ledger report in QuickBooks.

### Create a Custom Report

If a data source supports custom reports, a **Custom Reports** tab appears on the connection settings page. Clicking this tab opens the custom reports interface, as shown below:

<Frame>
  <img alt="Custom reports" />
</Frame>

To add a custom report, follow these steps:

<Steps>
  <Step>
    Click **Add** above the report table. A **Configure Table** dialog appears with a list of the custom reports available for your chosen data source.

    <Frame>
      <img alt="Add custom report" />
    </Frame>
  </Step>

  <Step>
    In **Step 1: Select Report**, select the report you want to use and click **Next**.
  </Step>

  <Step>
    In **Step 2: Customize Report**, set the parameters for the report, and then click **Save Report** to save the custom report to your account.
  </Step>
</Steps>

After you save a custom report, it appears in the list of tables for your connection. You can delete custom reports and add new ones as needed.

<Note>
  Custom reports are not shared across multiple connections to the same data source. For example, if you have two separate connections to Adobe Analytics, both connections will have their own lists of custom reports.
</Note>

### Use a Custom Report

You can query saved custom reports by passing the name of the custom report in the table field for your query. For example, if you have a custom report called *Customer Accounts List* on your QuickBooks Online connection, you could select all of its results with this query:

```sql wrap theme={null}
SELECT * FROM [QuickBooksOnline1].[QuickBooksOnline].[Customer Accounts List]
```

### Edit a Custom Report

To edit an existing custom report, follow these steps:

<Steps>
  <Step>
    In the report table, find the report you want to edit.
  </Step>

  <Step>
    Click the report name or type, or click the edit button.
  </Step>

  <Step>
    In **Edit Custom Report**, add or change report parameters.
  </Step>

  <Step>
    Click **Save Report**.
  </Step>
</Steps>

### Duplicate a Custom Report from an Existing Report

To duplicate an existing custom report, follow these steps:

<Steps>
  <Step>
    In the report table, find the report you want to duplicate.

    <Frame>
      <img alt="Duplicate custom report" />
    </Frame>
  </Step>

  <Step>
    Click the duplicate button. Connect AI creates a duplicate custom report for the data source with a new name.
  </Step>

  <Step>
    Edit the **Report Name**, if desired, and click **Save Report**.
  </Step>
</Steps>

### Delete a Custom Report

To delete an existing custom report, follow these steps:

<Steps>
  <Step>
    In the report table, find the report you want to delete.
  </Step>

  <Step>
    Click the delete button to the right of the report. Alternatively, you can select one or more reports on the **Custom Reports** tab and click **Delete**.
  </Step>

  <Step>
    Click **Delete** again in the dialog to confirm.
  </Step>
</Steps>


# Toolkits
Source: https://docs.cloud.cdata.com/en/Toolkits

Connect AI allows Admin users to define toolkits containing custom MCP tools for repeatable operations in your AI-driven workflows.

Custom MCP Tools give you precise control over agent behavior by codifying specific actions into reusable, deterministic steps that execute exactly as defined—every time. You create custom tools within a toolkit and then provide the endpoint to the toolkit to your AI agent.

For example, you can create an AI agent using Jira custom tools: the agent finds all unassigned high-priority Jira tickets and assigns them to the appropriate team members. You define the Jira custom tools in a toolkit. You then provide the AI agent with the toolkit endpoint containing the custom tools.

Access the **Toolkits** page by selecting **AI > Toolkits** in the Connect AI navigation menu.

<Frame>
  <img alt="List of toolkits" />
</Frame>

The **Toolkits** home page contains the following:

* The name of the available toolkits.
* The number of custom tools each toolkit contains.
* An icon of the data sources contained within each toolkit.
* A **Copy URL** button for copying the URL to the AI agent.
* A menu icon enabling you to edit, copy, or delete the toolkit.

## Prerequisites

* MCP toolkits are available to Growth+ customers only.
* Only Admin users can create and configure custom tools.
* To add connection tools, you need to set up one or more connections. See [Sources](/en/Sources) for more information.
* To add workspace tools, you need to set up one or more workspaces. See [Workspaces](/en/Workspaces) for more information.

## Custom Tool Types

There are two main tool types you can add to your toolkit: **connection tools** and **workspace tools**. In the edit screen of the toolkit, an icon represents connection tools, and a folder icon represents workspace tools.

<Frame>
  <img alt="Edit toolkit page" />
</Frame>

* **Connection Tools**–these tools apply to one or more connections. Within the connection tool, you can activate universal tools and source tools. You can also create custom tools for repeatable SQL queries and operations. Note that once connection(s) are assigned to a connection tool, they cannot be assigned to another connection tool.
* **Workspace tools**–these are tools that perform an action specific to the assets in your workspace. Within the workspace tool, you can activate universal tools. You can also create custom SQL tools.

Within connection and workspace tools, select the tab to activate the specific tools available for the tool type.

* **Universal Tools**–these are data exploration and manipulation operations built into Connect AI. They expose operations such as `getSchemas`, `getTables`, and `executeProcedure`. They are available for both connection and workspace tools. If you activate the tool, the tool includes every asset in the connection(s) or every asset in the workspace. Click an individual tool to view the description, annotations, and parameters of the tool. Click the information button for a complete explanation of the annotations. Note that universal tools can have dependencies: enabling one tool may require another tool to be enabled.
* **Source Tools (connection tools only)**–you can configure actions such as get, search, and create for each asset in a connection in order to optimize your query. For example, if you have a Jira connection, you can enable tools to search for, create, update, and delete issues. You can edit each tool to add AI instructions. You can also view required and optional parameters.
* **Custom SQL Tools**–you can create custom SQL tools for repeatable queries and operations. You can add optional or required parameters that are input to the SQL query.

## Add a New Toolkit

<Steps>
  <Step>
    In the main **Toolkits** page, click **Add**. An **Add Toolkit** dialog appears.
  </Step>

  <Step>
    Enter the name of the toolkit, and click **Confirm**. The new toolkit appears on the main **Toolkits** page.
  </Step>

  <Step>
    Select the toolkit to configure it.
  </Step>

  <Step>
    Add the **Toolkit Name**. The **MCP Remote Server URL** is autogenerated. This is the URL that you copy and paste into your MCP client application.
  </Step>

  <Step>
    Add **Server Instructions** to the MCP server, setting general toolkit boundaries such as "Use customer data only. Do not use external data."
    <Note>Not all MCP clients support server instructions.</Note>
  </Step>

  <Step>
    Click **Save Changes**. You can now add custom tools to the toolkit.
  </Step>
</Steps>

## Add a Custom Tool to a Toolkit

<Steps>
  <Step>
    Open the toolkit you want to add a tool to.
  </Step>

  <Step>
    Select whether the tool is a connection or workspace tool.
  </Step>

  <Step>
    Follow the steps in the wizard to add connection(s) or the workspace where the tool should reside. Click **Confirm**. The tool appears in your toolkit editor.
  </Step>

  <Step>
    Select the tool to edit it. The tool editor contains the following tabs: **Universal Tools**, **Source Tools** (connection tools only), and **Custom Tools**.
  </Step>

  <Step>
    In the **Universal Tools** tab, enable the universal tools for the connection or workspace. Select a tool to view a description of the tool, the tool's annotations, and the tool's parameters. Some tools have dependencies with other tools and must be enabled together.
  </Step>

  <Step>
    (Connection tools only) In the **Source Tools** tab, enable the tools to be used for the source(s). Select a tool to view a description of the tool and the tool's optional and required parameters. If desired, add **AI Instructions (MCP Context)**. This is where you can set boundaries and define the intent of the tool. Here are some guidelines for writing effective AI instructions for a custom tool:

    * Be clear and specific about the tool's purpose. Define what the tool does and what inputs it accepts.
    * Set clear boundaries. Explicitly state what the tool should and should not do.
    * Test your instructions against a wide variety of inputs.
  </Step>

  <Step>
    The **Custom Tools** tab is for advanced users. See [Add a Custom SQL Tool](#add-a-custom-sql-tool) for details on how to create custom SQL tools for your toolkit.
  </Step>

  <Step>
    When you are satisfied with the configuration of the custom tools, click **Save Changes**.
  </Step>
</Steps>

## Add a Custom SQL Tool

Custom tools can help you improve response accuracy in your AI agent. To add a custom SQL tool:

<Steps>
  <Step>
    Within the toolkit, select a connection or workspace tool in which to create the custom tool.
  </Step>

  <Step>
    In the tool editor, click the **Custom Tools** tab.

    <Frame>
      <img alt="Add a custom tool" />
    </Frame>
  </Step>

  <Step>
    Click **Add**. The custom tool editor appears.
  </Step>

  <Step>
    In the custom SQL editor, you can edit the tool name and add AI instructions. You can set boundaries for the type of data that can be returned.
  </Step>

  <Step>
    Create a SQL statement. The documentation contains a complete [SQL Reference](/en/SQL-Reference/SQL-Reference) for guidance.
  </Step>

  <Step>
    Optionally, add parameters to the SQL statement. If you add parameters to the SQL statement, you must add the parameter name in the **Parameters** section of the tool's definition.

    <Frame>
      <img alt="Custom SQL tool" />
    </Frame>

    <Note>If you use standard SQL for the SQL statement, any parameters you add must be **required** parameters, or the query fails. See [Use SQL Custom Templates](#use-sql-custom-templates) for instructions on creating queries with optional parameters.</Note>
  </Step>

  <Step>
    Click **Validate SQL**. You can also **Open in Data Explorer** to see the results of the SQL statement.
  </Step>

  <Step>
    Click **Save Changes** to save the custom SQL tool.
  </Step>

  <Step>
    The tool appears in your toolkit. When you are satisfied with the tool's configuration, enable the tool.
  </Step>
</Steps>

### Use SQL Custom Templates

Instead of standard SQL, you can use custom SQL templates to create a SQL statement in the custom SQL tool. Custom templates allow you to have optional parameters, or a combination of optional and required parameters.

The following two examples follow the SQL template for Bullhorn CRM for a `SELECT` statement. Refer to the data model for your data source to obtain the accepted parameters for the data source.

The following example shows a custom SQL template with both required and optional parameters:

```sql wrap theme={null}
SELECT * FROM {{catalog_name}}.BullhornCRM.Candidate
WHERE FirstName = @first_name
AND LastName = @last_name
{% if address %} AND AddressAddress = @address {% endif %}
{% if city %} AND AddressCity = @city {% endif %}
{% if state %} AND AddressState = @state {% endif %}
{% if zip %} AND AddressZip = @zip {% endif %}
{% if country_name %} AND AddresscountryName = @country_name {% endif %}
{% if email %} AND Email1 = @email {% endif %}
{% if mobile_phone %} AND MobilePhone = @mobile_phone {% endif %}
```

`@first_name` and `@last_name` are required. The rest of the parameters are optional. In the query, you can include any of the optional parameters, or none.

In this SQL template example, all parameters are optional individually, but the template requires that at least one be provided.

```sql wrap theme={null}
{% if first_name == blank and last_name == blank and email == blank and mobile_phone == blank and city == blank and state == blank %}
SELECT 'Error: at least one search parameter is required' AS ErrorMessage
{% else %}
SELECT * FROM {{catalog_name}}.BullhornCRM.Candidate
WHERE 1=1
{% if first_name %} AND FirstName = @first_name {% endif %}
{% if last_name %} AND LastName = @last_name {% endif %}
{% if email %} AND Email1 = @email {% endif %}
{% if mobile_phone %} AND MobilePhone = @mobile_phone {% endif %}
{% if city %} AND AddressCity = @city {% endif %}
{% if state %} AND AddressState = @state {% endif %}
{% endif %}
```

This query succeeds as long as one parameter is included. `WHERE 1=1` lets you safely append `AND` clauses without worrying about whether any conditions come before them.

## Add the Endpoint to Your Agent

Connect AI provides an endpoint to each toolkit. In the main **Toolkits** page, click **Copy URL** for the desired toolkit. If you want to view the actual URL, you can open the toolkit editor page. Copy the **MCP Remote Server URL** and paste it into your AI agent as a custom connector.


# Users
Source: https://docs.cloud.cdata.com/en/Users

The **Users** tab on the ***Users*** page enables you to manage the users on your Connect AI account.

A **User** is an account that can log in and use Connect AI. For non-human identities, see [Service Accounts](/en/Service-Accounts). For role definitions and access roles, see [Roles](/en/Roles).

The **Users** tab contains information about every user in Connect AI.

<Frame>
  <img alt="Users list" />
</Frame>

It contains the following information:

* The number of **user seats** that are available on your account.
* A row for every user on your account:
  * **User** displays the email address that is associated with the user.
  * **Role** indicates the user's system role.
  * **Status** shows the state of the user's account (**Active**, **Inactive**, or **Invited**).
  * Edit and delete icons for the user. If the user's status is **Invited**, there is also an icon to resend the user's invitation.

## Invite Users

<Note>
  If you have Just-in-Time (JIT) provisioning enabled, you do not need to invite users manually.
</Note>

To add users to your Connect AI account, follow these steps:

<Steps>
  <Step>
    In the **Users** tab, click **Invite Users** to open the user invitation dialog.
  </Step>

  <Step>
    Enter the email address of the user that you want to invite. To send multiple invitations at the same time, add a space between each email address.

    <Frame>
      <img alt="Invite users" />
    </Frame>

    <Note>
      If you invite multiple users at the same time, they will have the same role(s). You can change their role(s) individually after sending the invitation.
    </Note>
  </Step>

  <Step>
    Select the **System Role** for the new user(s).
  </Step>

  <Step>
    (Optional) Select an **Access Role** for the new user(s).
  </Step>

  <Step>
    (Query users only) Toggle on **Support Access Privileges** if you want the user(s) to be able to authorize support access to their account. Administrators can revoke support access at any time.
  </Step>

  <Step>
    (Optional) Select **Permissions** for the new user(s). Select the allowed permissions for each entity (data connection or workspace) in the system. Administrators and Connection Administrators can edit permissions later.

    For more information about permissions, see [Permissions and Access Control](/en/Permissions).
  </Step>

  <Step>
    Click **Send Invite**. If a user is registered already to an email address that you enter, the dialog prompts you to enter a different email address.
  </Step>
</Steps>

### Accept an Invitation

Follow these steps to set up access after receiving an invitation email:

<Steps>
  <Step>Click **Accept Invite** in the invitation email to open the password creation page.</Step>

  <Step>
    Create a password that meets the provided criteria. After you create a password, the login page
    appears.
  </Step>

  <Step>
    Log in with your email address and your new password. After you log in, the sign-up page
    appears.
  </Step>

  <Step>Enter your first name and last name.</Step>

  <Step>
    Enter the account name and the invite code from the invitation email. Then, click **Complete
    Sign Up**.

    <Frame>
      <img alt="User signup" />
    </Frame>
  </Step>
</Steps>

<Note>
  Connect AI supports Single Sign-On (SSO) through popular SSO providers. If SSO is enabled on your
  account, the invitation flow uses your SSO provider instead of the manual password process.
</Note>

### Manage Invitations

If a user has a pending invitation that they have not accepted, their status displays as **Invited**. Click a pending user to view and manage their invitation.

On this page, you can view the pending user's email address, the expiration time for the invitation, and the invite code. You can also manage the user's invitation, as follows:

* To revoke the invitation and delete the user, click **Delete User**.
* To resend the invitation email to the entered email address, click **Resend Invite**.

## Edit Users

Click a user in the list (or click the **Edit** button) to open the **Edit User** page.

<Frame>
  <img alt="Edit user" />
</Frame>

This page contains the following information:

* Editable **First Name** and **Last Name** fields.
* A non-editable **Email** field.
* A drop-down menu to select the user's **System Role**.
* A drop-down menu to select an additional **Access Role** (optional). These are any access roles that were created.
* A toggle for enabling or disabling **Support Access Privileges** (query users only). If enabled, the query user can grant account access to the CData support team.
* Check boxes for toggling the user's permissions for each data source. (Note that CData Connect Spreadsheets users do not have a permissions section, because they have full permissions.)

To save changes to the user, click **Save Changes**.

## Delete Users

To delete the user, click **Delete User**.

<Note>
  If the user is the last remaining Administrator on your account, they cannot be deleted.
</Note>


# Workspaces
Source: https://docs.cloud.cdata.com/en/Workspaces

The **Workspaces** feature is a data catalog that streamlines the accessibility of diverse data sources.

## Overview

Workspaces provide a way to organize, catalog, and control access to specific data (assets) in Connect AI. You can bundle related assets separately in a scalable way. Workspaces offer a customizable organization scheme that streamlines data analysis across numerous business functions.

In the Connect AI data catalog, you can view a preview of the workspace’s column metadata.

Workspace assets can be:

* **Folders**–you can create one level of folders within a workspace.
* **Tables and Views**–from connected Connect AI data sources
* **Derived Views**–derived from one or many data sources in Connect AI

Tables, views, and derived views are exposed directly without transformations, so the column names and other properties remain the same. Any table, view, or derived view can be added to any number of workspaces. They can be referenced by a unique **Alias**. Tables that are workspaces support full CRUD capabilities.

## Add a Workspace

Workspaces are the highest level of organization. They are customizable to adjust to various business needs. A business unit like marketing or data science can have their own separate workspaces. Sales may organize folders in their workspace for each client. Teams can pick the structure that supports them best.

To get started, you can create a workspace using the following steps:

<Steps>
  <Step>
    Click **Workspaces** on the left side of the dashboard.
  </Step>

  <Step>
    Click **Add** on the top right side.
  </Step>

  <Step>
    Enter a **Workspace Name**.
  </Step>

  <Step>
    Click **Confirm** to create your new workspace.
  </Step>
</Steps>

After setting a name and description for a *Workspace*, SQL Server, OData, and OpenAPI **Endpoints** are automatically generated. Endpoints are the door to a wide range of connections that form the backbone of workspaces.

To view connection details for connecting from a workspace via Virtual SQL Server, OData, or OpenAPI, click **View Endpoints**. The **Endpoints** dialog contains three tabs, one for **Virtual SQL Server**, one for **OData**, and one for **OpenAPI**.

### Inbound Connections

When connecting to Connect AI from a client application, you can connect directly to a workspace via workspace-specific endpoints. Connect AI supports several endpoints for inbound connections, including a REST API, Virtual SQL Server, OData, and OpenAPI. You can identify endpoints quickly via a configurable naming structure that places periods between workspace, folder, and asset names by default—for example, *Workspace.Folder.Asset*.

Connect AI supports the OpenAPI specification version 2.0 and 3.0, allowing you to connect no-code/low-code applications that integrate with OpenAPI. Connect AI allows you to connect a workspace via OpenAPI by downloading an OpenAPI document from a workspace and importing the file in your client application.

#### Connect to the REST API

To make a connection to the REST API, add a URL parameter to the REST API URL named “workspace”. Set this to the name of the workspace you want to query. This works with both the GET operation on the metadata endpoint, as well as the POST operation on the query and batch endpoints. Note that the /exec endpoint does not support workspaces.

#### Connect via Virtual SQL Server

The **Virtual SQL Server** tab of the **Endpoints** dialog contains the settings you need to connect from a workspace via Virtual SQL Server clients. Copy the settings in the dialog.

<Frame>
  <img alt="Workspace SQL Server settings" />
</Frame>

* **Username**—your username to connect to a workspace is in the format of `[your_email_address]@[workspace_name]`.
* **SQL Server Host Name**—the SQL Server host name (*tds.cdata.com*).
* **Port**—the SQL Server port (*14333*).
* **Database**—the name of the workspace (if required).
* **Password**—click **Create PAT** to create a Personal Access Token to use as your password during authentication.

#### Connect via OData

The **OData** tab of the **Endpoints** dialog contains the settings you need to connect from a workspace via OData clients. Copy the settings in the dialog.

<Frame>
  <img alt="Workspace OData settings" />
</Frame>

* **Username**—your username to connect to a workspace is in the format of your email address.
* **OData URL**—the workspace name you want to connect to. The URL has the format `https://cloud.cdata.com/api/odata/{workspace_name}`.
* **Password**—click **Create PAT** to create a Personal Access Token to use as your password during authentication.

#### Connect via OpenAPI

The **OpenAPI** tab of the **Endpoints** dialog contains the settings you need to connect from a workspace via OpenAPI. You can generate an OpenAPI specification file for the selected workspace. This file can be used in client applications to integrate with Connect AI via OpenAPI.

<Frame>
  <img alt="Workspace OpenAPI" />
</Frame>

<Steps>
  <Step>
    Select version 2.0 or 3.0 of OpenAPI.
  </Step>

  <Step>
    Toggle **Convert array types to strings** on if the client application does not support array types (such as Microsoft Power Apps).
  </Step>

  <Step>
    Click **Download** to download the OpenAPI specification file for the workspace. This is the file that is imported into the client application.
  </Step>

  <Step>
    You can also copy and paste the **OpenAPI URL**.
  </Step>
</Steps>

#### Connect to Development Tools (JDBC/ODBC/SSIS)

To make a connection from the workspace to CData development tools, enter the workspace name in the **Workspace** field in the **Advanced** tab of the driver for Connect AI. Below is an example for the JDBC driver.

<Frame>
  <img alt="JDBC specify workspace" />
</Frame>

#### Connection Authentication

To authenticate, use your Connect AI email address as your username. You need a Personal Access Token (PAT) to use as your password. You can generate a PAT in the **Endpoints** dialog or on the [Settings](/en/Settings/Personal-Access-Tokens) page.

## Workspace Assets

The assets created within workspaces link to specific data items and provide a second layer of organization. You can organize assets into folders, but you cannot create subfolders. On the left of the asset is an icon specifying whether the asset is a folder, table, or derived view. On the right of the asset is an icon displaying the data source of the asset (not applicable for derived views).

<Frame>
  <img alt="Workspace assets" />
</Frame>

To create an asset inside of the workspace:

<Steps>
  <Step>
    Within the workspace, click **Add** on the top right side. The **Add Asset** dialog appears.

    <Frame>
      <img alt="Add asset" />
    </Frame>
  </Step>

  <Step>
    Select from the menu what you want to add:

    * **Folder**
    * **Tables and Views**
    * **Derived Views**
      If you select **Folder**, enter the folder name. If you select **Tables and Views**, you must select the connection and the tables or views to add. If you select **Derived Views**, you must select the derived views to add.
  </Step>

  <Step>
    Click **Confirm**.
  </Step>
</Steps>

When you click on an asset in a workspace, the horizontal tabs offer the following functionality:

* **Columns**–a table with the column metadata
* **Preview**–the connected data item’s contents in a preview table
* **SQL**–a generated reference SQL query for a table, view, or derived view, including the configurable **Alias** which is an important reference when querying.

### Data Model

The data model follows a `Workspace.Folder.Table` design. If no folder is present in the hierarchy, it displays as `[ROOT]`. For more information about the data model, refer to [SQL Reference](/en/SQL-Reference/SQL-Reference#data-model).


# Getting Started
Source: https://docs.cloud.cdata.com/en/docs

*Connect AI* is a consolidated connectivity platform that links applications to a broad ecosystem of real-time data sources through consistent, standards-compliant interfaces. Connect AI provides tools to access data seamlessly from any system, anywhere.

With Connect AI, you can unify access to all of the cloud applications, databases, APIs, and services across an organization.

## Key Features

* **Broad Data Connectivity:** Connect AI allows you to transform data into a standard language that any reporting tool, analytics dashboard, or spreadsheet can understand. It can connect to a vast range of applications (including those for accounting, marketing, customer relationship management, and more) by using a consistent approach that is already supported by many data tools.
* **Real-Time Data Access:** Connect AI gives you access to your data in real time, which creates an agile and flexible work environment that adapts and changes as quickly as your data does. This approach avoids the pitfalls of traditional Extract, Transform, Load (ETL) processes that rely on moving data to separate locations.
* **Create, Read, Update, Delete (CRUD) Support:** Read and Write operations are supported. Operations are controlled by security settings that you can configure in Connect AI or in your data sources.
* **Secure Access:** Administrators can create query users and define their access permissions for each data source individually.
* **Comprehensive Data Model & Dynamic Discovery:** Connect AI provides comprehensive access to all of the data that is exposed in the underlying connections, including full access to dynamic data and searchable metadata.
* **Workspaces:** Connect AI provides a sleek way to organize, catalog, and control access to specific data. You can bundle related data items separately in a scalable way with workspaces.

For more information about these key features, see [Technology](/en/Technology).

## Get Started

Connect an AI agent to your data over MCP and ask it a question. You choose the data in Step 3: a public
sample file that needs no credentials, or your own source.

<Card title="Quick Start" icon="robot" href="/en/Quick-Start-Guide">
  **Five minutes with the sample file, or 15 with your own source.** Connect an agent, add a data source,
  and query it, then use the same connection from the REST and OData APIs and your BI tools.
</Card>

## What to Read Next

After the quick start, these pages go deeper into each part of the workflow.

**Connect and query your data**

* [Sources](/en/Sources)—Add and manage connections to your data sources, and find setup instructions for each one.
* [Data Explorer](/en/Data-Explorer)—Run SQL, build queries, and create derived views.
* [SQL Reference](/en/SQL-Reference/SQL-Reference)—Supported SQL syntax and code examples.

**Use your data from AI agents**

* [MCP](/en/API/MCP)—The MCP endpoint, authentication, and the full tool list.
* [AI Tools](/en/Clients/AITools)—Setup instructions for ChatGPT, Claude, Cursor, Copilot Studio, n8n, and more.
* [Toolkits](/en/Toolkits)—Limit an agent to only the tables and operations it needs.

**Use your data from applications and BI tools**

* [Integrations](/en/Integrations)—Connect BI, ETL, and no-code tools.
* [API](/en/API/API)—Connect through the REST API, OData, and OpenAPI protocols.
* [Virtual Databases](/en/Virtual-Databases)—Query Connect AI as a SQL Server endpoint.

**Govern access**

* [Workspaces](/en/Workspaces)—Group sources and derived views, and share them with teams.
* [Permissions](/en/Permissions)—Grant access by need-to-know.
* [Data Security](/en/Data-Security)—Rate limits, IP allowlists, and audit logging.
* [Dashboard](/en/Dashboard)—Navigate Connect AI and monitor account activity.

## Get Support

For assistance with using *Connect AI*, there are two main resources available:

* The [Status page](https://status.cdata.com/), which shows the current status and incident history for the application services.
* [CData Technical Support](https://www.cdata.com/support/submit.aspx), which you can also access by clicking the **Support** link at the bottom of the dashboard.


# CData Docs
Source: https://docs.cloud.cdata.com/en/index



<div>
  <div>
    <br />

    <br />

    # Welcome to Connect AI

    <p>
      Connect AI is a managed platform for reading, writing, and acting on hundreds of SaaS, database, and API sources through secure, standards-based access. One governed layer for your entire stack: MCP for AI agents, ODBC/JDBC for BI tools, REST/OData for custom apps. Your data stays accessible, protected, and ready—wherever you need it.
    </p>

    <div>
      <a href="https://cloud-login.cdata.com/u/signup">
        Sign up
      </a>

      <a href="https://cloud-login.cdata.com/u/login">
        Log in
      </a>
    </div>
  </div>

  <div>
    <div>
      <div>
        <span>
          <Icon icon="grid" />
        </span>

        <span>
          <Icon icon="grid" />
        </span>
      </div>

      ### Many sources, one interface

      <p>
        Unify access to 300+ sources and tools (BI, iPaaS, no-code builders) without building one-off integrations.
      </p>

      <a href="/en/Data-Sources/Salesforce">Data Sources →</a>
    </div>

    <div>
      <div>
        <span>
          <Icon icon="shield-user" />
        </span>

        <span>
          <Icon icon="shield-user" />
        </span>
      </div>

      ### Enterprise controls

      <p>
        SSO, user credentials, and workspaces to isolate and govern access.
      </p>
    </div>

    <div>
      <div>
        <span>
          <Icon icon="database" />
        </span>

        <span>
          <Icon icon="database" />
        </span>
      </div>

      ### APIs

      <p>
        Full REST API with SQL-grade semantics, plus a virtual SQL Server endpoint for tooling that speaks TDS.
      </p>

      <a href="/en/API/API">API Reference →</a>
    </div>
  </div>

  <div>
    <div>
      ## Get started in 5 minutes

      <p>
        Setting up your first connection should be the most straightforward part of getting started. With quick authentication and fast connection setup, you will be up and running in minutes—not hours.
        <p>No guesswork, no complexity—just your first successful prompt, fast.</p>
      </p>

      <a href="/en/Quick-Start-Guide">
        <span>
          <Icon icon="rocket" />
        </span>

        <span><Icon icon="rocket" /></span> Get started
      </a>
    </div>

    <div>
      <img />
    </div>
  </div>

  <div>
    <div>
      <pre>
        ```bash theme={null}
        {`async def get_mcp_tools(session: ClientSession):
            """Set up the list of MCP tools that will be used to interact with"""
            mcp_tools = await session.list_tools()
            return [
                types.Tool(
                    function_declarations=[
                        types.FunctionDeclaration(
                            name=tool.name,
                            description=tool.description,
                            parameters={
                                p: v for p, v in tool.inputSchema.items()
                            }
                        )
                    ]
                )
                for tool in mcp_tools.tools
                if tool.name in BOX_MCP_TOOLS
            ]`}
        ```
      </pre>
    </div>

    <div>
      ## Learn more about the developer platform

      <p>
        This guide covers three high-impact areas you'll implement first: (1) Connectivity & Modeling, (2) Security & Governance, and (3) Programmatic Access & Jobs.
      </p>

      <a href="/en/API/API">
        <span>
          <Icon icon="book" />
        </span>

        <span><Icon icon="book" /></span> Documentation
      </a>
    </div>
  </div>
</div>


# Campaigner
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Campaigner



## Prerequisites

Before you can add the connection, you must generate an API key from your Campaigner account:

<Steps>
  <Step>
    Sign in to your Campaigner account and go to **Account Settings** > **Users**.
  </Step>

  <Step>
    Click **Create New User**.
  </Step>

  <Step>
    Under **User Role**, select **API User**, then click **Save**.
  </Step>

  <Step>
    An API key is generated for the new API user. Copy it and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Campaigner to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Campaigner* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** from your Campaigner account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Capsule CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-CapsuleCRM



## Prerequisites

Before you can add the connection, you must register an OAuth application with Capsule CRM:

<Steps>
  <Step>
    Go to the [Capsule CRM developer portal](https://developer.capsulecrm.com/signIn) and sign in with your GitHub username and password.
  </Step>

  <Step>
    Click **Create New Application**.
  </Step>

  <Step>
    Enter a name for the application and set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save the application, then copy the **Client ID** and **Client Secret**. In Connect AI, these are entered as the **OAuth Client Id** and **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Capsule CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Capsule CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Capsule CRM.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Capsule CRM sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Capsule CRM account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# ClickUp
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Clickup



## Prerequisites

Before you can add the connection, you must obtain a personal API token from ClickUp:

<Steps>
  <Step>
    Sign in to your [ClickUp account](https://app.clickup.com) and open your user settings.
  </Step>

  <Step>
    Navigate to the **Apps** section.
  </Step>

  <Step>
    At the top of the page, generate a personal token and copy it.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect ClickUp to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *ClickUp* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your personal token as the **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Close CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-CloseCRM



## Prerequisites

Before you can add the connection, you must generate an API key from your Close CRM account:

<Steps>
  <Step>
    Log in to your Close CRM account and navigate to **Settings**, then **Your API Keys**.
  </Step>

  <Step>
    Click **New API Key**. Copy the generated key. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Close CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Close CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key** from the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Cloudflare
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Cloudflare



## Prerequisites

Before you can add the connection, you must obtain credentials from your Cloudflare account. Cloudflare supports two key types:

* **API Token**: A scoped token with specific permissions. Recommended for most use cases.
* **Global API Key**: The permanent key tied to your account. Requires your account email address.

To retrieve your credentials:

<Steps>
  <Step>
    Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and go to **My Profile** > **API Tokens**.
  </Step>

  <Step>
    To use an API Token, click **Create Token**, configure the required permissions, and copy the generated token.
  </Step>

  <Step>
    To use your Global API Key, navigate to the **API Keys** section and copy the key. You will also need the email address associated with your Cloudflare account.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Cloudflare to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Cloudflare* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set **Key Type** to **API Token** or **Global API Key**, depending on the credentials you are using.
  </Step>

  <Step>
    Enter your **API Key** (your API Token value or Global API Key value).
  </Step>

  <Step>
    If you are using a Global API Key, enter the **API Email** associated with your Cloudflare account. **API Email** is not required for token authentication.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Coda
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Coda



## Prerequisites

To authenticate to Coda, you must generate an API token from your account settings:

<Steps>
  <Step>
    Log in to your Coda account and click your profile avatar in the upper-right or lower-left corner.
  </Step>

  <Step>
    Select **Account settings** or **Settings** from the menu.
  </Step>

  <Step>
    Scroll down to the **API settings** section and click **Generate API token**.
  </Step>

  <Step>
    Enter a name for the token and optionally add read/write restrictions for specific docs.
  </Step>

  <Step>
    Click **Generate API token**, then click **Copy token** to copy it to your clipboard.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Coda to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Coda* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Coda account settings.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Collaboflow
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Collaboflow



## Prerequisites

Before you can add the connection, you must gather the following from your Collaboflow account.

<Steps>
  <Step>
    Log in to Collaboflow as an administrator.
  </Step>

  <Step>
    Open the **System Management Area** > **App Management** and note the **App Cd** (app code) of the workflow application you want to connect to.
  </Step>

  <Step>
    Note your **Instance**, which is the instance name in your Collaboflow API URL. The URL format is `https://cloud.collaboflow.com/{instance}/api/index.cfm`, so the Instance is the segment between the domain and `/api/index.cfm` (for example, *mycompany* in `https://cloud.collaboflow.com/mycompany/api/index.cfm`).
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Collaboflow to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Collaboflow* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **App Cd** obtained from Collaboflow.
  </Step>

  <Step>
    Enter the **Instance**, which is the instance portion of your Collaboflow URL.
  </Step>

  <Step>
    Enter the **URL** of the Collaboflow API endpoint, in the format *[https://cloud.collaboflow.com/\{instance}/api/index.cfm](https://cloud.collaboflow.com/\{instance}/api/index.cfm)* (for example, *[https://cloud.collaboflow.com/mycompany/api/index.cfm](https://cloud.collaboflow.com/mycompany/api/index.cfm)*).
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="APIKey">
    To use API Key authentication, you must generate an API key from your Collaboflow administrator account:

    <Steps>
      <Step>
        Open the **System Management Area** > **Environment Settings**.
      </Step>

      <Step>
        Scroll to the **REST API** section. Enter a client name, select **HTTP Header Authentication**, then click **+ Issue API Key**. Copy the **API Key** and store it securely.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **API Key** generated from your Collaboflow admin account.
      </Step>

      <Step>
        Enter the **User**, which is the Collaboflow username used to authenticate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User**, which is your Collaboflow username.
      </Step>

      <Step>
        Enter the **Password** used to authenticate to Collaboflow.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Constant Contact
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ConstantContact



## Prerequisites

Before you can connect to Connect AI, you must register an OAuth application in the Constant Contact Developer Portal:

<Steps>
  <Step>
    Log in to the [Constant Contact Developer Portal](https://v3.developer.constantcontact.com) and click the **My Applications** tab.
  </Step>

  <Step>
    Click **New Application**.
  </Step>

  <Step>
    Enter a name for your application, then click **Create**.
  </Step>

  <Step>
    In your application's settings, add *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)* as a redirect URL.
  </Step>

  <Step>
    Make note of the **API Key** (used as the OAuth Client Id in Connect AI) and generate a **Client Secret**. The Client Secret is displayed only once, so copy it immediately and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Constant Contact to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Constant Contact* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** (your Constant Contact API Key) and **OAuth Client Secret**.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Constant Contact sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Constant Contact account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Kit (Formerly ConvertKit)
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ConvertKit



## Prerequisites

Before you can add the connection, you must obtain your API credentials from your Kit account:

<Steps>
  <Step>
    Log in to your Kit account and go to **Account Settings** > **Advanced** > **API**.
  </Step>

  <Step>
    Copy your **API Key** and **API Secret**, then store them securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Kit to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Kit* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Secret** from your Kit account.
  </Step>

  <Step>
    Enter the **API Key** from your Kit account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Copper
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Copper



## Prerequisites

Before you can add the connection, you must generate an API key from your Copper account:

<Steps>
  <Step>
    Log in to your Copper CRM web application and navigate to **Settings** > **Integrations** > **API Keys**.
  </Step>

  <Step>
    Click **Generate API Key** and enter a label for the key.
  </Step>

  <Step>
    Copy the generated API key. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Copper to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Copper* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    Enter the **User Email** address associated with your Copper API key.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Discord
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Discord



## Setup Guide

Follow these steps to connect Discord to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Discord* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    To use OAuth authentication, you must register an application in the Discord Developer Portal:

    <Steps>
      <Step>
        Visit the [Discord Developer Portal](https://discord.com/developers/applications) and click **New Application**.
      </Step>

      <Step>
        Provide a name for your application, then click **Create**.
      </Step>

      <Step>
        Navigate to the **OAuth2** section.
      </Step>

      <Step>
        Add a redirect URL and set it to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Copy the **Client ID** and **Client Secret**. Store the client secret securely. In Connect AI, the Client ID is entered as the **OAuth Client Id** and the Client Secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the Discord Developer Portal.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Discord sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Discord account and grant the requested permissions.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIKey">
    To use API Key authentication, you must set up a bot application in the Discord Developer Portal:

    <Steps>
      <Step>
        Visit the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application or select an existing one.
      </Step>

      <Step>
        Navigate to the **Bot** section.
      </Step>

      <Step>
        Create a bot if one does not exist.
      </Step>

      <Step>
        Copy the **Bot Token**.
      </Step>

      <Step>
        Configure the bot permissions as needed.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the bot token as the **API Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Egnyte
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Egnyte



## Prerequisites

Before you can add the connection, you must register an OAuth application with Egnyte.

<Steps>
  <Step>
    Go to the [Egnyte Developers portal](https://developers.egnyte.com/) and sign in or create a developer account.
  </Step>

  <Step>
    Click **Create App** to begin registering a new application.
  </Step>

  <Step>
    Complete the required fields:

    * **App Name**–the name of your application.
    * **Redirect URL**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Submit the application. Once approved, Egnyte provides an **API Key** and **Secret** for your application. Make note of these values.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Egnyte to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Egnyte* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Domain**. This is the subdomain portion of your Egnyte URL. For example, if your Egnyte URL is *[https://acmeinc.egnyte.com/](https://acmeinc.egnyte.com/)*, the Domain is *acmeinc*.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Egnyte. The API Key is the OAuth Client Id, and the Secret is the OAuth Client Secret.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Egnyte sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Egnyte account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# EmailOctopus
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-EmailOctopus



## Prerequisites

Before you can add the connection, you must obtain an API key from your EmailOctopus account:

<Steps>
  <Step>
    Log in to your EmailOctopus account and click **Integrations API** in the navigation menu.
  </Step>

  <Step>
    Click **API**, then click **Developer API**.
  </Step>

  <Step>
    Under **Your API Keys**, copy your API key and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect EmailOctopus to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *EmailOctopus* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your EmailOctopus account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Everhour
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Everhour



## Prerequisites

Before you can add the connection, you must locate your API token in your Everhour account:

<Steps>
  <Step>
    Log in to your Everhour account and go to your **Profile** settings.
  </Step>

  <Step>
    Scroll to the bottom of the page to find your **API Token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Everhour to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Everhour* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** from your Everhour profile.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Exa
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Exa



## Prerequisites

Before you can add the connection, you must generate an API key from your Exa account:

<Steps>
  <Step>
    Go to the [Exa dashboard](https://dashboard.exa.ai) and register for an account or log in.
  </Step>

  <Step>
    Navigate to the API settings section.
  </Step>

  <Step>
    Generate or copy your API key.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Exa to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Exa* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your Exa account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Figshare
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Figshare



## Prerequisites

Before you can add the connection, you must generate a personal token from your Figshare account:

<Steps>
  <Step>
    Go to the [applications page](https://figshare.com/account/applications) at Figshare and log in.
  </Step>

  <Step>
    Under **Personal tokens**, enter a description and click **Create token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Figshare to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Figshare* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** using your Figshare personal token.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Float
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Float



## Prerequisites

Before you can add the connection, you must generate an API access token from your Float account:

<Steps>
  <Step>
    Log in to your Float account as the Account Owner and navigate to **Company Settings**.
  </Step>

  <Step>
    Click **Integrations**, then **Float API**.
  </Step>

  <Step>
    Copy the API access token. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Float to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Float* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key** (your Float API access token) from the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Formsite
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Formsite



## Prerequisites

Before you can add the connection, locate the following values in your Formsite account:

<Steps>
  <Step>
    Log in to your Formsite account and navigate to the **Admin Portal**.
  </Step>

  <Step>
    Go to the **API** or **Integrations** settings section.
  </Step>

  <Step>
    Generate a new API key or copy your existing key. This is entered as the **API Key** in Connect AI.
  </Step>

  <Step>
    Note your **Server** value. This is the number in your Formsite URL — for example, if your URL is `fs18.formsite.com`, the server number is `18`.
  </Step>

  <Step>
    Note your **User Directory**. This is your account directory, visible in the URL of your Formsite forms.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Formsite to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Formsite* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **API Key**—the API token from your Formsite account.
    * **Server Number**—the server number from your Formsite URL (for example, `18` for `fs18.formsite.com`).
    * **User Directory**—the user directory path for your Formsite account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# FreshBooks
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Freshbooks



## Prerequisites

Before you can add the connection, you need to register an OAuth application with FreshBooks. You must be signed in to a FreshBooks account that has admin access.

<Steps>
  <Step>
    Go to the [FreshBooks developer portal](https://my.freshbooks.com/#/developer) and sign in.
  </Step>

  <Step>
    Click **Create New App**.
  </Step>

  <Step>
    Complete the required fields:

    * **Name**–the name of your application.
    * **Description**–(optional) a short description of your application.
    * **Redirect URI**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save the application.
  </Step>

  <Step>
    On the application page, scroll to **App Settings** to find the **Client Id** and **Client Secret**. Make note of these values.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect FreshBooks to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *FreshBooks* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Connect AI, enter the **OAuth Client Id** and **OAuth Client Secret** obtained from FreshBooks.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the FreshBooks sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your FreshBooks account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Freshservice
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Freshservice



## Setup Guide

Follow these steps to connect Freshservice to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Freshservice* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain**, which is the subdomain of your Freshservice account URL. For example, if your Freshservice URL is *[https://yourcompany.freshservice.com](https://yourcompany.freshservice.com)*, the **Domain** is *yourcompany*.
  </Step>

  <Step>
    Enter the Freshservice **API Key**. Find your API Key in the Freshservice portal under your **Profile settings** in the top-right corner. You must be an account administrator to access the API key.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Freshteam
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Freshteam



## Setup Guide

Follow these steps to connect Freshteam to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Freshteam* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Account Name**, which is the subdomain of your Freshteam account URL. For example, if your Freshteam URL is *[https://yourcompany.freshteam.com](https://yourcompany.freshteam.com)*, the **Account Name** is *yourcompany*.
  </Step>

  <Step>
    Enter the Freshteam **API Key**. Find your API Key in the Freshteam portal under your **Profile settings**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Front
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Front



## Prerequisites

Before you can add the connection, you must create an OAuth application in Front. You must be a Front admin to do this.

<Steps>
  <Step>
    In Front, go to **Settings** > **Company** > **Developers**.
  </Step>

  <Step>
    Click **Create app**, enter an **App name** and **Short description**, then click **Save**.
  </Step>

  <Step>
    Click your new app, open the **Features** tab, click **Add feature**, then click **OAuth** and **Enable OAuth**. The **Client ID** and **Client secret** appear immediately. Copy them and store the client secret securely.
  </Step>

  <Step>
    Click **Add Redirect URL** and enter *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Front to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Front* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication

<Steps>
  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Front.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Front sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Front account and grant the requested permissions.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# GetResponse
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-GetResponse



## Setup Guide

Follow these steps to connect GetResponse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *GetResponse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Auth Scheme, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="APIKey">
    To use API Key authentication, retrieve your X-Auth-Token from your GetResponse account:

    <Steps>
      <Step>
        Log in to [app.getresponse.com](https://app.getresponse.com), click your profile avatar in the upper-right corner, and select **My account**.
      </Step>

      <Step>
        Select **Use GetResponse API**.
      </Step>

      <Step>
        Copy the X-Auth-Token displayed on the page.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the X-Auth-Token as the **API Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    To use OAuth authentication, you must register an application with GetResponse:

    <Steps>
      <Step>
        Go to [app.getresponse.com/authorizations](https://app.getresponse.com/authorizations) and register a new application.
      </Step>

      <Step>
        Complete the required fields:

        * **Name**–the name of your application.
        * **Short description**–a brief description of your application.
        * **Redirect URL**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        After saving, click the application to view its credentials. Make note of the **client\_id** and **client secret**. In Connect AI, the client\_id is entered as the **OAuth Client Id** and the client secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from GetResponse.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the GetResponse sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your GetResponse account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# GitLab
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-GitLab



## Setup Guide

Follow these steps to connect GitLab to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *GitLab* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    To use OAuth authentication, you need to register an OAuth application with GitLab. You can register either a user-owned application or a group-owned application:

    <Steps>
      <Step>
        Open the **Applications** page in GitLab:

        * **User-owned**–select your avatar in the upper-right corner, click **Edit profile**, then select **Applications** from the left sidebar.
        * **Group-owned**–open the group, then in the left sidebar select **Settings** > **Applications**.
      </Step>

      <Step>
        Click **Add new application**.
      </Step>

      <Step>
        Complete the required fields:

        * **Name**–the name of your application.
        * **Redirect URI**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
        * **Confidential**–leave this checkbox selected.
        * **Scopes**–select the OAuth 2.0 scopes your integration needs (for example, `api`, `read_user`, `read_api`, `read_repository`).
      </Step>

      <Step>
        Click **Save application**.
      </Step>

      <Step>
        On the application page, make note of the **Application ID** and **Secret**. The Secret is only shown once, so copy it immediately. In Connect AI, the Application ID is entered as the **OAuth Client Id** and the Secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from GitLab.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the GitLab sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your GitLab account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIKey">
    To use API Key authentication, first create a personal access token in GitLab:

    <Steps>
      <Step>
        Select your avatar in the upper-right corner and click **Edit profile**.
      </Step>

      <Step>
        In the left sidebar, select **Access Tokens** (or **Access** > **Personal access tokens** on newer GitLab versions), then click **Add new token**.
      </Step>

      <Step>
        Complete the required fields:

        * **Token name**–a descriptive name for the token.
        * **Expiration date**–required by GitLab.
        * **Scopes**–select the scopes your integration needs. Use `api` for full read/write API access, or narrower read-only scopes such as `read_api`, `read_user`, and `read_repository`.
      </Step>

      <Step>
        Click **Create personal access token**.
      </Step>

      <Step>
        Copy the token immediately and store it securely. GitLab only displays the token once.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **API Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Gong
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Gong



## Prerequisites

Before you can add the connection, you need to generate API credentials from your Gong account. You must be a Gong administrator to do this.

<Steps>
  <Step>
    Log in to Gong and go to **Admin center** > **Settings** > **Ecosystem** > **API**.
  </Step>

  <Step>
    Click **Get API Key** (or **Create**) to generate a new key.
  </Step>

  <Step>
    Copy the **Access Key** and **Access Key Secret** and store them securely. Gong only displays the Access Key Secret once.
  </Step>

  <Step>
    Note the **Base URL** displayed at the top of the Gong API page. You use this value as the **Domain** when you set up the connection.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Gong to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Gong* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain**, which is the Base URL shown at the top of the Gong API page.
  </Step>

  <Step>
    Enter the **API Key**, which is the Access Key generated in Gong.
  </Step>

  <Step>
    Enter the **API Secret**, which is the Access Key Secret generated in Gong.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Forms
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-GoogleForms



## Prerequisites

Before you can add the connection, you must create an OAuth app in the Google Cloud Console to obtain a Client ID and Client Secret:

<Steps>
  <Step>
    Navigate to [https://console.cloud.google.com](https://console.cloud.google.com) and sign in.
  </Step>

  <Step>
    Create or select a project, then navigate to **APIs & Services** > **Library** and enable the **Google Forms API**.
  </Step>

  <Step>
    Navigate to **APIs & Services** > **Credentials** and click **Create credentials** > **OAuth client ID**.
  </Step>

  <Step>
    Select **Web application** as the application type.
  </Step>

  <Step>
    Under **Authorized redirect URIs**, add *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Create**. Copy the **Client ID** and **Client Secret** and store them securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Google Forms to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Forms* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the prerequisites.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Google sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Google account and provide the requested permissions.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Grafana
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Grafana



## Prerequisites

To authenticate to Grafana, you must provide a Service Account Token or an API Key:

<Steps>
  <Step>
    In your Grafana account, open the side menu and click **Administration**, then select **Users and Access** > **Service accounts**.
  </Step>

  <Step>
    Create a new service account, then open its page and click **Add service account token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

<Note>On older versions of Grafana, use an API Key. If your instance was recently updated, there is an option to migrate API keys to service accounts under the **API Keys** section.</Note>

## Setup Guide

Follow these steps to connect Grafana to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Grafana* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key**, which is the Service Account Token or API Key obtained from your Grafana instance.
  </Step>

  <Step>
    Enter the **Domain**, which is the subdomain portion of your Grafana URL. For example, if your Grafana URL is *[https://acmeinc.grafana.net/](https://acmeinc.grafana.net/)*, the Domain is *acmeinc*.
  </Step>

  <Step>
    Enter the **URL** of your Grafana instance (for example, *[https://acmeinc.grafana.net/](https://acmeinc.grafana.net/)*).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Guru
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Guru



## Prerequisites

Before you can add the connection, you need a Guru account username and an API token to authenticate.

<Steps>
  <Step>
    Log in to your Guru account.
  </Step>

  <Step>
    Go to **Settings** > **API**.
  </Step>

  <Step>
    Click **Create New API Token**.
  </Step>

  <Step>
    Copy the generated API token and store it securely. Guru only displays the token once.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Guru to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Guru* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **User**, which is the Guru account username or email address used to authenticate.
  </Step>

  <Step>
    Enter the **Password**, which is the API token used to authenticate to Guru.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Hive
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Hive



## Prerequisites

Before you can add the connection, you must locate your API key and user ID from your Hive account:

<Steps>
  <Step>
    Log in to your Hive account and open the main menu in the top-right corner.
  </Step>

  <Step>
    Select **API Information**.
  </Step>

  <Step>
    Copy your **API Key** and **User ID**. Store the API key securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Hive to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Hive* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **User Id** from your Hive account.
  </Step>

  <Step>
    Enter your **API Key** from your Hive account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Jotform
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-JotForm



## Prerequisites

Before you can add the connection, you must create an API key from your Jotform account:

<Steps>
  <Step>
    Log in to your Jotform account and navigate to **My Account**, then **API Section**.
  </Step>

  <Step>
    Click **Create a New API Key**. Copy the key and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Jotform to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Jotform* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    If you are connecting to a Jotform Enterprise account, enter your **Team Id**.
  </Step>

  <Step>
    Enter your **API Key** from the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Jumpseller
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Jumpseller



## Prerequisites

Before you can add the connection, you must register an OAuth application with Jumpseller:

<Steps>
  <Step>
    Log in to your Jumpseller admin and navigate to **Apps**, then click **Developers > Add Application**. Fill out the application form and set the **Redirect URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    After saving, Jumpseller assigns your application a **Client ID** and **Client Secret**. Copy both values and store them securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Jumpseller to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Jumpseller* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Jumpseller.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Jumpseller sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Jumpseller account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# iContact
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-iContact



## Prerequisites

Before you can add the connection, you must create a custom API integration in your iContact account:

<Steps>
  <Step>
    Log in to your iContact account and click the dropdown menu in the upper-right corner, then select **Settings and Billing**.
  </Step>

  <Step>
    Click **iContact Integrations**.
  </Step>

  <Step>
    Click the **Create** button next to **Custom API Integrations**.
  </Step>

  <Step>
    Under the **Getting Connected** section, note your **API Application ID** (App Id), **Username**, and **Password**.
  </Step>

  <Step>
    Note your **Account Id** from the **Account Information** section of the same page.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect iContact to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *iContact* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Account Id** and **App Id** obtained from your iContact Custom API Integration page.
  </Step>

  <Step>
    Set the **User** to your iContact username and the **Password** to your iContact password.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dataverse
Source: https://docs.cloud.cdata.com/en/Data-Sources/CDS



## Setup Guide

Follow these steps to connect Dataverse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dataverse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Organization URL** to your organization's Dataverse data (for example, `https://abc123.crm.dynamics.com/`).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Select a **Schema** from the drop down. System is used for optimal performance, while Entities provides more user-friendly table names.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Dataverse sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Dataverse account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** that you will use to access data.
      </Step>

      <Step>
        Enter your **OAuth Client Id**.
      </Step>

      <Step>
        Enter your **OAuth Client Secret**.
      </Step>

      <Step>
        Enter your **OAuth JWT Cert**. This is a multi-line key.
      </Step>

      <Step>
        Select your **OAuth JWT Cert Type** from the drop down.
      </Step>

      <Step>
        Select a **Schema** from the drop down. System is used for optimal performance, while Entities provides more user-friendly table names.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Dataverse, see [this information page](https://cdn.cdata.com/help/UVM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# CSV
Source: https://docs.cloud.cdata.com/en/Data-Sources/CSV



## Setup Guide

Follow these steps to connect CSV to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *CSV* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI** for the CSV resource location.
  </Step>

  <Step>
    (Optional) Enter the **FMT**. This specifies the file format that the provider uses to parse all text files. The default value is CsvDelimited.
  </Step>

  <Step>
    (Optional) Toggle on **Aggregate Files**. This specifies whether the provider aggregates all files with the same schema in the specified folder into a single table called AggregatedFiles.
  </Step>

  <Step>
    (Optional) Toggle on **Include Column Headers**. This specifies whether the provider derives column names from the first row of each file.
  </Step>

  <Step>
    Select the **Connection Type**, which specifies the file storage service, server, or file access protocol through which your CSV files are stored and retrieved. Then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Connection Types

<Tabs>
  <Tab title="Amazon S3">
    <Steps>
      <Step>
        Select the **AWS Region** from the drop-down list. This is the hosting region for your Amazon Web Services.
      </Step>

      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme** to use when connecting to remote services. Then select the tab for your authentication scheme and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AwsRootKeys">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsEC2Roles">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsIAMRoles">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Role ARN**. This is the Amazon Resource Name of the role to use when authenticating.
          </Step>

          <Step>
            (Optional) Enter the **AWS External Id**. This is a unique identifier that might be required when you assume a role in another account.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsTempCredentials">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to AWS. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Session Token**. See the [AWS Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) for more information about the session token.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsCredentialsFile">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Keycloak">
        <Steps>
          <Step>
            Enter the **Keycloak Realm URL**. This specifies the full URL to the Keycloak server, including the specific realm used for authentication and authorization.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Blob Storage">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2 SSL">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Files">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Box">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Dropbox">
    <Steps>
      <Step>
        (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTP">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTPS">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Google Cloud Storage">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Google Drive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS Secure">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTP">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTPS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="IBM Object Storage Source">
    <Steps>
      <Step>
        Enter the **Api Key** used to identify the user to the IBM Cloud.
      </Step>

      <Step>
        Enter the **Region**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from the security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneDrive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneLake">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Oracle Cloud Storage">
    <Steps>
      <Step>
        Enter the hosting **Region** for your S3-like Web Services.
      </Step>

      <Step>
        Enter the **Oracle Namespace**. This is the Oracle Cloud Object Storage namespace to use.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SFTP">
    <Steps>
      <Step>
        Select the **SSH Auth Mode**, which is the type of authentication to use when connecting to remote services. Then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Password">
        <Steps>
          <Step>
            Enter the **SSH User** used to authenticate to the SFTP server.
          </Step>

          <Step>
            Enter the **SSH Password** used to authenticate to the SFTP server.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Public_Key">
        <Steps>
          <Step>
            Enter the **SSH Client Cert**, which is the name of the certificate store for the client certificate.
          </Step>

          <Step>
            Select the **SSH Client Cert Type**, which is the type of key store containing the client certificate.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Password**. This is the password for the client certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Subject**. This is the subject of the SSH client certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint SOAP">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and CSV, see [this information page](https://cdn.cdata.com/help/RVM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Cassandra
Source: https://docs.cloud.cdata.com/en/Data-Sources/Cassandra



## Setup Guide

Follow these steps to connect Cassandra to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Cassandra* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Server**, which is the host name or IP address of the server hosting the Cassandra database.
  </Step>

  <Step>
    Enter the **Port** for the Cassandra database. The default port is 9042.
  </Step>

  <Step>
    (Optional) Enter the **Database**, which is the name of the Cassandra keyspace containing the tables.
  </Step>

  <Step>
    (Optional) Set **Use SSL** to enable SSL.
  </Step>

  <Step>
    (Optional) Select the **Consistency Level**, which determines how many of the replicas of the data you are interacting with need to respond for the query to be considered a success. The default is `ONE`.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="DSE">
    **DSE** authenticates against a DataStax Enterprise cluster.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Kerberos">
    **Kerberos** authenticates through a Kerberos ticket.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="LDAP">
    **LDAP** authenticates against an external LDAP server.

    <Steps>
      <Step>
        Enter the **LDAP Server**, which is the host name or IP address of the LDAP server.
      </Step>

      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        (Optional) Enter the **LDAP Port** for the LDAP server. The default port is 389.
      </Step>

      <Step>
        (Optional) Enter the **Default LDAP User** and **LDAP Password**. These must be set if the LDAP server does not allow anonymous bind.
      </Step>

      <Step>
        (Optional) Enter the **Search Base** for your LDAP server, used to look up users.
      </Step>

      <Step>
        (Optional) Enter the **Search Filter** for looking up usernames in LDAP. The default is `(uid=)`. When using Active Directory, set the filter to `(sAMAccountName=)`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Cassandra, see [this information page](https://cdn.cdata.com/help/RCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Cloudant
Source: https://docs.cloud.cdata.com/en/Data-Sources/Cloudant



## Setup Guide

Follow these steps to connect Cloudant to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Cloudant* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the URL of your Cloudant instance.
  </Step>

  <Step>
    Select an **Auth Scheme** from the drop down.
  </Step>

  <Step>
    If you choose **Basic**, enter the following information:

    * **User**—the Cloudant username for authentication.
    * **Password**—the user password.
  </Step>

  <Step>
    If you choose **OAuth**, enter the IAM **API key**. See the [Cloudant documentation](https://cloud.ibm.com/Cloudant?topic=Cloudant-managing-access-for-cloudant) for more information.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>

  <Step>
    In Cloudant, add the Connect AI static IP addresses to your connection whitelist.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Cloudant, see [this information page](https://cdn.cdata.com/help/EWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# CockroachDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/CockroachDB



## Prerequisites

#### Whitelist CData IPs

To establish a connection to CockroachDB, you need to allow access to CockroachDB via CData’s IP. When hosting CockroachDB behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure CockroachDB Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect CockroachDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *CockroachDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Password**—the user password
    * **User**—the CockroachDB username for authentication
    * **Server**—the host name or IP address of the CockroachDB server
    * **Database**—the name of the CockroachDB database you want to access, set as the default database if not specified
    * **Port**—the port for connecting to the CockroachDB server
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and CockroachDB, see [this information page](https://cdn.cdata.com/help/HJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Confluence
Source: https://docs.cloud.cdata.com/en/Data-Sources/Confluence



## Setup Guide

Follow these steps to connect Confluence to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Confluence* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **URL**—Set to the URL to your Jira endpoint in the form `https://[YourSiteName].atlassian.net/`.
        * **OAuth Client Id**—Set to the client Id in your app settings.
        * **OAuth Client Secret**—Set to the client secret in your app settings.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Confluence sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Confluence account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Note>
      Basic authentication is only applicable for Server instances. For Cloud instances, use APIToken authentication.
    </Note>

    <Steps>
      <Step>
        Enter the following information:

        * **URL**—Set to the URL to your Jira endpoint in the form `https://[YourSiteName].atlassian.net/`.
        * **User**—the Confluence username for authentication.
        * **Password**—the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIToken">
    <Note>
      APIToken is only applicable for Cloud instances. For Server instances, use Basic authentication.
    </Note>

    <Steps>
      <Step>
        Enter the following information:

        * **URL**—Set to the URL to your Jira endpoint in the form `https://[YourSiteName].atlassian.net/`.
        * **User**—the Confluence username for authentication.
        * **API Token**—the API token for the current user. To create an API token, go to the **Security** tab of your Atlassian account and click **Create and manage API tokens**. On the **API Tokens** page, click **Create API token**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Crowd">
    <Steps>
      <Step>
        Enter the following information:

        * **URL**—Set to the URL to your Jira endpoint in the form `https://[YourSiteName].atlassian.net/`.
        * **User**—The Crowd user account.
        * **Password**—The password associated with the Crowd account.
        * **SSO Login URL**—The login URL associated with the Crowd account. You can find the IDP URL by navigating to **your application > SSO > SSO information > Identity provider single sign-on URL**.
        * **SSO Exchange URL**—The URL used to exchange the SAML token for Confluence cookies. This URL can have the following formats:
          * https\:///plugins/servlet/samlconsumer
          * https\:///plugins/servlet/samlsso
        * **SSO App Name**—The name of the application in which SSO is enabled.
        * **SSO App Password**—The password of the application in which SSO is enabled.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the following information:

        * **URL**—Set to the URL to your Jira endpoint in the form `https://[YourSiteName].atlassian.net/`.
        * **User**—The Okta user account.
        * **Password**—The password associated with the Okta account.
        * **SSO Login URL**—Set to the URL used by the SSO provider.
        * **SSO Properties**—(Optional) This is needed if you use MFA, applications that override the Okta requests, or a proxy. Otherwise it can be left blank.
        * **SSO Exchange URL**—The URL used to exchange the SAML token for Confluence cookies. This URL can have the following formats:
          * https\:///plugins/servlet/samlconsumer
          * https\:///plugins/servlet/samlsso
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PAT">
    <Steps>
      <Step>
        In your Atlassian account, go to **Profile** > **Personal Access Tokens** > **Create token**. Copy and paste the PAT here.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Confluence, see [this information page](https://cdn.cdata.com/help/UGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Cosmos DB
Source: https://docs.cloud.cdata.com/en/Data-Sources/CosmosDB



## Setup Guide

Follow these steps to connect Cosmos DB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Cosmos DB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Cosmos DB account URL **Account Endpoint**. You can find this URL under the **Keys** blade of the Cosmos DB account.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AccountKey">
    <Steps>
      <Step>
        Enter the master key token or resource token for connecting to the Cosmos DB REST API in the **Account Key** field.
      </Step>

      <Step>
        Use the **Token Type** field to specify whether the token you entered in the **Account Key** field is a **master** or **resource** token.
      </Step>

      <Step>
        In Cosmos DB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Cosmos DB account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Cosmos DB account for OAuth.
      </Step>

      <Step>
        In Cosmos DB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        Enter the **OAuth Client Id** found in your application settings.
      </Step>

      <Step>
        Enter your **OAuth Client Secret**.
      </Step>

      <Step>
        In Cosmos DB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Cosmos DB, see [this information page](https://cdn.cdata.com/help/EHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Couchbase
Source: https://docs.cloud.cdata.com/en/Data-Sources/Couchbase



## Setup Guide

Follow these steps to connect Couchbase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Couchbase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select which **Couchbase Service** to connect to, **Analytics** or **N1QL**.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Couchbase username for authentication.
        * **Password**—the user password.
        * **Server**—the host name or IP address of the Couchbase server or servers to which you are connecting.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Couchbase, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SSLCertificate">
    <Steps>
      <Step>
        Enter the following information:

        * **SSL Client Cert**—the contents of your certificate file. A sample is displayed.
        * **SSL Client Cert Password**—the client certificate password if it is encrypted.
        * **Server**—the host name or IP address of the Couchbase server or servers to which you are connecting.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Couchbase, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Couchbase, see [this information page](https://cdn.cdata.com/help/CKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Cvent
Source: https://docs.cloud.cdata.com/en/Data-Sources/Cvent



## Prerequisites

Before obtaining OAuth credentials, you need to create a custom OAuth application in Cvent if you do not already have one.

To create an OAuth application in Cvent:

<Steps>
  <Step>
    Navigate to the [Cvent Developer Portal's Applications page](https://developers.cvent.com/) and click **Create application**.
  </Step>

  <Step>
    Select the **Machine to Machine** application type.
  </Step>

  <Step>
    Under **Application name**, specify a name for the application.
  </Step>

  <Step>
    Click **Select scopes** and select all of the scopes you want to add to your application. You are limited to the scopes allowed by the Workspace.
  </Step>

  <Step>
    Click **Save** to create the application.
  </Step>

  <Step>
    Click **View Applications** to return to the Applications page.
  </Step>
</Steps>

Note the values of the **Client ID** and **Client secret**. You will use these below to authenticate to Cvent.

## Setup Guide

Follow these steps to connect Cvent to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Cvent* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuthClientId** from the prerequisites.
  </Step>

  <Step>
    Enter the **OAuthClientSecret** from the prerequisites.
  </Step>

  <Step>
    (Optional) Enter the **Scope** of the authenticating user's access to the application. This can be done when you create the OAuth application.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dynamics 365 Business Central
Source: https://docs.cloud.cdata.com/en/Data-Sources/D365BusinessCentral



## Setup Guide

Follow these steps to connect Dynamics 365 Business Central to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dynamics 365 Business Central* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your organization's URL in the **Organization URL** field (for example, `https://businesscentral.dynamics.com/abc123/`).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter the name of the Company to connect to, if more than one company exists in your organization.
      </Step>

      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Dynamics 365 Business Central sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Dynamics 365 Business Central account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        Enter **OAuth Client Id** in your application settings.
      </Step>

      <Step>
        Enter your **OAuth Client Secret** or your **OAuth JWT Cert**.
      </Step>

      <Step>
        Select your **OAuth JWT Cert Type** from the drop down.
      </Step>

      <Step>
        (Optional) Enter your **OAuth JWT Cert Password** if you are using an encrypted OAuth JWT Cert.
      </Step>

      <Step>
        (Optional) Enter the name of the Company to connect to, if more than one company exists in your organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Dynamics 365 Business Central, see [this information page](https://cdn.cdata.com/help/FBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# DB2
Source: https://docs.cloud.cdata.com/en/Data-Sources/DB2



## Setup Guide

Follow these steps to connect DB2 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *DB2* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the name of the **Server** running DB2.
  </Step>

  <Step>
    Enter the **Port** the DB2 is listening on.
  </Step>

  <Step>
    Enter the name of the DB2 **Database**.
  </Step>

  <Step>
    (Optional) Select whether you want to **Use SSL**.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="USRIDPWD">
    <Steps>
      <Step>
        To authenticate with user credentials, enter the following information:

        * **User**—enter the username of a user with access to the database.
        * **Password**—enter the password of a user with access to the database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="EUSRIDPWD">
    <Steps>
      <Step>
        To authenticate with encrypted user credentials, select **EUSRIDPWD** and enter the following information:

        * **User**—enter the username of a user with access to the database.
        * **Password**—enter the password of a user with access to the database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="IBMIAMAuth">
    <Steps>
      <Step>
        To authenticate using the API key of an application that connects to it, select **IBMIAMAuth** and enter the following information:

        * **User**—enter the IBM ID or service ID of a DB2 server user.
        * **Password**—enter the API key associated with the application that requires access to the DB2 database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Databricks
Source: https://docs.cloud.cdata.com/en/Data-Sources/Databricks



## Setup Guide

Follow these steps to connect Databricks to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Databricks* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="PersonalAccessToken">
    <Steps>
      <Step>
        Enter your Databricks access token into the **Token** field. To obtain the token, navigate to the **User Settings** page of your Databricks instance and open the **Access Tokens** tab.
      </Step>

      <Step>
        Enter the Databricks **Catalog** if you are using Databricks Unity Catalog. Otherwise, leave the default value.
      </Step>

      <Step>
        Enter the **HTTP Path** component of the URL endpoint.
      </Step>

      <Step>
        Enter the **Server** URL or IP address of the Databricks instance .
      </Step>

      <Step>
        (Optional) Enter the name of the **Database** to connect to.
      </Step>

      <Step>
        In Databricks, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User** name for Databricks.
      </Step>

      <Step>
        Enter your Databricks access token into the **Token** field. To obtain the token, navigate to the **User Settings** page of your Databricks instance and open the **Access Tokens** tab.
      </Step>

      <Step>
        Enter the Databricks **Catalog** if you are using Databricks Unity Catalog. Otherwise, leave the default value.
      </Step>

      <Step>
        Enter the **HTTP Path** component of the URL endpoint.
      </Step>

      <Step>
        Enter the **Server** URL or IP address of the Databricks instance .
      </Step>

      <Step>
        (Optional) Enter the name of the **Database** to connect to.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant Id** of your Azure application.
      </Step>

      <Step>
        Enter the **Azure Client Id** for your Azure application.
      </Step>

      <Step>
        Enter the **Azure Client Secret** corresponding to the above Azure Client Id.
      </Step>

      <Step>
        Enter the **Azure Subscription Id** of your Microsoft Azure Databricks Service Workspace.
      </Step>

      <Step>
        Enter the **Azure Resource Group** name of your Microsoft Azure Databricks Service Workspace.
      </Step>

      <Step>
        Enter the **Azure Workspace** of your Microsoft Azure Databricks Service Workspace.
      </Step>

      <Step>
        Enter the **Catalog** if you are using Databricks Unity Catalog. Otherwise, leave the default value.
      </Step>

      <Step>
        Enter the **HTTP Path** component of the URL endpoint.
      </Step>

      <Step>
        Enter the **Server** URL or IP address of the Databricks instance .
      </Step>

      <Step>
        (Optional) Enter the name of the **Database** to connect to.
      </Step>

      <Step>
        In Databricks, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Catalog** if you are using Databricks Unity Catalog. Otherwise, leave the default value.
      </Step>

      <Step>
        Enter the **HTTP Path** component of the URL endpoint.
      </Step>

      <Step>
        Enter the **Server** URL or IP address of the Databricks instance .
      </Step>

      <Step>
        (Optional) Enter the name of the **Database** to connect to.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Databricks sign-in page in a new tab.
      </Step>

      <Step>
        In Databricks, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Private Cloud Connector Connection

Databricks is a supported connector with Private Cloud Connector, which acts as a bridge between your on-premises data and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information. Once you set up the gateway, you can select the **Connection Type** of **Private Cloud Connector**. Then enter **Location Name** of the gateway and the Databricks authentication information.

## More Information

For more information about interactions between Connect AI and Databricks, see [this information page](https://cdn.cdata.com/help/LKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Docusign
Source: https://docs.cloud.cdata.com/en/Data-Sources/DocuSign



## Prerequisites

Before you can establish a connection with Docusign using the OAuth authentication method, you must create and configure a custom OAuth application.

<Steps>
  <Step>
    In Docusign, navigate to **Settings** > **Integrations** > **Apps and Keys**.
  </Step>

  <Step>
    Click **Add App and Integration Key** and name your application.
  </Step>

  <Step>
    Click **Create App**.
  </Step>

  <Step>
    In **General Info**, note the **Integration Key** field. You need to copy and paste this key into the **OAuthClientId** field in Connect AI.
  </Step>

  <Step>
    In **Authentication** > **Secret Keys**, click **Add Secret Key**. You need to copy and paste this key into the **OAuth Client Secret** field in Connect AI.
  </Step>

  <Step>
    In **Additional Settings** > **Redirect URIs**, click **Add URI**. Enter `https://oauth.cdata.com/oauth/` as the redirect URI.
  </Step>

  <Step>
    (Optional) If you are using JWT authentication, in **Service Integration** > **RSA Keypairs**, click **Generate RSA** to generate an RSA public key and private key. You need to copy and paste the private key into the **OAuth JWT Cert** field in Connect AI.
  </Step>

  <Step>
    (Optional) If you are using JWT authentication, in the **Apps and Keys** home page, note **My Account Information** > **User ID**. You need to copy and paste this key into the **OAuth JWT Subject** field in Connect AI.
  </Step>
</Steps>

Refer to the [Docusign documentation](https://developers.docusign.com/platform/build-integration/) for more details about building a Docusign integration.

## Setup Guide

Follow these steps to connect Docusign to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Docusign* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        For **OAuth Client Id**, copy and paste the Docusign integration key you created in the prerequisites.
      </Step>

      <Step>
        For **OAuth Client Secret**, copy and paste the secret key you created in the prerequisites.
      </Step>

      <Step>
        The **Callback URL** is the redirect URI for your OAuth app. On Connect AI, this is `https://oauth.cdata.com/oauth/`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Docusign sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Docusign account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        For **OAuth JWT Cert**, copy and paste the RSA private key you generated in the prerequisites.
      </Step>

      <Step>
        For **OAuth JWT Subject**, copy and paste your Docusign user Id. Retrieve your user Id in Docusign by navigating to **Settings** > **Apps and Keys** > **My Account Information** > **User ID**.
      </Step>

      <Step>
        For **OAuth JWT Issuer**, copy and paste the Docusign integration key you created in the prerequisites.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Docusign, see [this information page](https://cdn.cdata.com/help/UCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Domino
Source: https://docs.cloud.cdata.com/en/Data-Sources/Domino



## Setup Guide

Follow these steps to connect Domino to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Domino* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Domino, if the Proton component has not been installed, install it before continuing. See the Domino documentation for instructions on acquiring and installing Proton or the AppDev pack.
  </Step>

  <Step>
    Enter the following information:

    * **SSL Client Cert**—the content of the TLS/SSL client certificate file for client authentication
    * **SSL Client Cert Type**—the format of the TLS/SSL client certificate file
    * **SSL Client Cert Password**—the Private Key Password. Only required when your Private Key has been encrypted.
    * **SSL Server Cert**—You only need to set this if you are using a certificate that is not issued by a certificate authority. You can also set this to '\*' to accept all certificates (not recommended for production use cases).
    * **Database**—the name of the Domino database file, including the `.nsf` extension
    * **Port**—the port number that the Proton service is listening on
    * **Server**—the hostname or IP address of the Domino server
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Domino, see [this information page](https://cdn.cdata.com/help/JKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dropbox
Source: https://docs.cloud.cdata.com/en/Data-Sources/Dropbox



## Setup Guide

Follow these steps to connect Dropbox to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dropbox* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Impersonate User Mode** the provider uses when making API calls on behalf of a user or administrator: **User**, **Admin**, or **None**.
  </Step>

  <Step>
    Enter the **Impersonate User Id** which specifies the Dropbox User Id to impersonate when acting on behalf of a team member or administrator. This field is required if you select **User** or **Admin** for **Impersonate User Mode**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  The directions above assume you are using CData's embedded OAuth app. If you want to create a custom OAuth app, see [Creating a Custom OAuth App](https://cdn.cdata.com/help/OFM/cloud/default.htm#pg_oauthcustomappcreate). After you have created a custom OAuth app, go to the **Advanced Settings** tab and enter the **OAuth Client Id** and **OAuth Client Secret** you obtained from the custom OAuth app.
</Note>

## More Information

For more information about interactions between Connect AI and Dropbox, see [this information page](https://cdn.cdata.com/help/OFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dynamics 365
Source: https://docs.cloud.cdata.com/en/Data-Sources/Dynamics365



## Setup Guide

Follow these steps to connect Dynamics 365 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dynamics 365* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your organization's URL in the **Organization URL** field (for example, `https://businesscentral.dynamics.com/abc123/`).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Select your edition of Dynamics 365 in the **Edition** drop-down menu.
      </Step>

      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Dynamics 365 sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Dynamics 365 account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        Enter **OAuth Client Id** in your application settings.
      </Step>

      <Step>
        Enter your **OAuth Client Secret** or your **OAuth JWT Cert**.
      </Step>

      <Step>
        Select your edition of Dynamics 365 in the **Edition** drop-down menu.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Dynamics 365, see [this information page](https://cdn.cdata.com/help/LJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dynamics CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/DynamicsCRM



## Prerequisites

In Dynamics CRM, [create a custom OAuth application](#create-a-custom-oauth-application) (if you are not using embedded credentials).

## Setup Guide

Follow these steps to connect Dynamics CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dynamics CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **CRM Version**—the CRM version. Choose either **CRM2011+** or **CRMOnline** from the drop-down list.
    * **URL**—the root URL of the organization. The formatting of this URL depends on the version of CRM that you use.
  </Step>

  <Step>
    (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
  </Step>

  <Step>
    (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Dynamics CRM sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Dynamics CRM account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## Create a Custom OAuth Application

Follow these steps to create a custom OAuth Application in Dynamics CRM:

<Steps>
  <Step>
    Open your Azure portal and open the navigation pane. Select **Azure Active Directory**, then **App Registrations**.
  </Step>

  <Step>
    Click **New Registration**.
  </Step>

  <Step>
    Enter the following information:

    * **Name**—a name for the application (for example, *Connect AI*).
    * **Supported account types**—select **Accounts in any organization directory**.
    * **Redirect URI**—select **Web** and enter *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*
  </Step>

  <Step>
    Click **Register** to create the application.
  </Step>

  <Step>
    In the application view, select **Certificates & Secrets**.
  </Step>

  <Step>
    Select **New Client Secret**, set a duration, and save it. When the key value appears, copy it down to use when establishing the connection.
  </Step>

  <Step>
    Select **API permissions** and click **Add a permission**.
  </Step>

  <Step>
    Select **Dynamics CRM** and select **Delegated permissions**. Select **user\_impersonation** in the permissions list.
  </Step>

  <Step>
    Click **Add permissions** to save your changes.
  </Step>

  <Step>
    Select **Overview** and copy down the value for **Application (client) ID**.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Dynamics CRM, see [this information page](https://cdn.cdata.com/help/RMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dynamics NAV
Source: https://docs.cloud.cdata.com/en/Data-Sources/DynamicsNAV



## Setup Guide

Follow these steps to connect Dynamics NAV to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dynamics NAV* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** to the Microsoft Dynamics NAV server organization root. For example, *[http://MyServer:7048](http://MyServer:7048)*.
  </Step>

  <Step>
    Enter the **Server Instance**, which is the instance of the Dynamics NAV server. For example, *DynamicsNAV71*.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Negotiate">
    Set to **Negotiate** if you want the provider to negotiate an authentication mechanism with the server.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="NTLM">
    Set to **NTLM** to use your Windows credentials to authenticate.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    Set to **Basic** to use HTTP Basic authentication.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Digest">
    Set to **Digest** to use HTTP Digest authentication.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this authentication method.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Dynamics NAV, see [this information page](https://cdn.cdata.com/help/CNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# eBay
Source: https://docs.cloud.cdata.com/en/Data-Sources/Ebay



## Setup Guide

Follow these steps to connect eBay to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *eBay* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    If you have not already, join the eBay Developers Program. On the eBay Developers Program dashboard, navigate to **My Account** > **Application Access Keys**.

    1. Copy down the values for **App ID**, **DevID**, and **Cert ID**.
    2. Click **Get a User Token Here** to generate an access token. Set the Redirect URI to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)* and copy down your token.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the App ID you obtained from the Application Access Keys page.
        * **OAuth Client Secret**—the Cert ID you obtained from the Application Access Keys page.
        * **Ru Name**—(optional) the Redirect URL name used for validation. This property is only needed if you are using the provider to allow other users to access their own data.
        * **Use Sandbox**—set only if you are using a sandbox account.
        * **Site ID**—the Id of the eBay site that you want to connect to. The default value of 0 is for eBay U.S.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AuthNAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **Dev ID**—the DevID you obtained from the Application Access Keys page.
        * **OAuth Client Id**—the App ID you obtained from the Application Access Keys page.
        * **OAuth Client Secret**—the Cert ID you obtained from the Application Access Keys page.
        * **OAuth Access Token**—the access token you generated above.
        * **Ru Name**—(optional) the Redirect URL name used for validation. This property is only needed if you are using the provider to allow other users to access their own data.
        * **Use Sandbox**—set only if you are using a sandbox account.
        * **Site ID**—the Id of the eBay site that you want to connect to. The default value of 0 is for eBay U.S.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and eBay, see [this information page](https://cdn.cdata.com/help/BEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# eBay Analytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/EbayAnalytics



## Prerequisites

Before you connect eBay Analytics to Connect AI, you must join the eBay Developers Program and create an application to obtain OAuth credentials.

<Steps>
  <Step>
    If you have not already done so, join the [eBay Developers Program](https://developer.ebay.com/).
  </Step>

  <Step>
    On the eBay Developers Program dashboard, navigate to **My Account** > **Application Access Keys**.
  </Step>

  <Step>
    On the **Application Keys** page, create an OAuth application and request credentials for either the **Production** or **Sandbox** environment, depending on whether you need access to real store data or a testing environment.
  </Step>

  <Step>
    Copy down the values for **App ID (Client ID)** and **Cert ID (Client Secret)**.
  </Step>

  <Step>
    Next to your App ID, click **User Tokens**, then select **Get a Token from eBay via Your Application**. Make sure **OAuth enabled** is selected.
  </Step>

  <Step>
    Configure a Redirect URL (RuName) for your application. Set the accepted URL to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)* and copy down the **RuName** value generated by eBay.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect eBay Analytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *eBay Analytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Ru Name**, which is the Redirect URL name used for validation (obtained in the prerequisites).
  </Step>

  <Step>
    (Optional) Select a **Marketplace Id** for the eBay Marketplace you want to connect to. Supported values are `DEFAULT`, `EBAY_AU`, `EBAY_CA`, `EBAY_FR`, `EBAY_DE`, `EBAY_GB`, `EBAY_IT`, `EBAY_ES`, and `EBAY_US`. The default value is `DEFAULT`.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the App ID you obtained from the **Application Access Keys** page.
        * **OAuth Client Secret**—the Cert ID you obtained from the **Application Access Keys** page.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the eBay sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your eBay account and grant the requested permissions.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the App ID you obtained from the **Application Access Keys** page in Ebay Analytics.
        * **OAuth Client Secret**—the Cert ID you obtained from the **Application Access Keys** page in Ebay Analytics.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and eBay Analytics, see [this information page](https://cdn.cdata.com/help/JJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Elasticsearch
Source: https://docs.cloud.cdata.com/en/Data-Sources/Elasticsearch



## Prerequisites

In Elasticsearch, add the Connect AI static IP addresses to your connection whitelist.

## Setup Guide

Follow these steps to connect Elasticsearch to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Elasticsearch* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the REST **Server**'s host name or IP address.
  </Step>

  <Step>
    Enter the port for connecting to the Elasticsearch server.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="BASIC">
    <Steps>
      <Step>
        Enter the Elasticsearch username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWS RootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Region** where the ElasticSearch instance is hosted.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        Enter the **AWS Region** where the ElasticSearch instance is hosted.
      </Step>

      <Step>
        (Optional) If emulating a different role, enter it into the **AWS External Id** field.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="API Key">
    <Steps>
      <Step>
        Enter the **API Key** received from ElasticSearch.
      </Step>

      <Step>
        Enter the **API Key Id** returned alongside the above API Key.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Elasticsearch, see [this information page](https://cdn.cdata.com/help/EEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Email
Source: https://docs.cloud.cdata.com/en/Data-Sources/Email



## Setup Guide

Follow these steps to connect email to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Email* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **User**, which is the user of the email account used to authenticate.
  </Step>

  <Step>
    Enter the **Password** of the email account used to authenticate.
  </Step>

  <Step>
    Enter the **Server**, which is the name or address of the mail server.
  </Step>

  <Step>
    Select the **Protocol** that matches the type of email server you are connecting to: **IMAP** or **POP**. The default value is **IMAP**.
  </Step>

  <Step>
    (Optional) Enter the **Port** of the mail server. The default value is *143* for IMAP and *110* for POP.
  </Step>

  <Step>
    (Optional) Select an **SSL Mode** to specify the authentication mechanism used when connecting to the email server. Supported values are **AUTO**, **NONE**, **IMPLICIT**, and **EXPLICIT**. The default value is **NONE**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and email, see [this information page](https://cdn.cdata.com/help/REM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# EnterpriseDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/EnterpriseDB



## Setup Guide

Follow these steps to connect EnterpriseDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *EnterpriseDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **User** field, enter the EnterpriseDB username for authentication.
  </Step>

  <Step>
    In the **Password** field, enter the password to authenticate with the EnterpriseDB server.
  </Step>

  <Step>
    (Optional) In the **Server** field, enter the host name or IP address of the EnterpriseDB Postgres Advanced Server.
  </Step>

  <Step>
    (Optional) In the **Database** field, enter the name of the EnterpriseDB database to connect to. If a database is not provided, the user's default database is used.
  </Step>

  <Step>
    (Optional) In the **Port** field, enter the port for connecting to the EnterpriseDB server. The default port is *5444*.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and EnterpriseDB, see [this information page](https://cdn.cdata.com/help/JEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Epicor Kinetic
Source: https://docs.cloud.cdata.com/en/Data-Sources/EpicorERP



## Setup Guide

Follow these steps to connect Epicor Kinetic to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Epicor Kinetic* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **URL**—the base URL of the server hosting your Epicor Kinetic instance, without a trailing path (for example, *[https://example123.developer.epicor.com](https://example123.developer.epicor.com)*). Contact your Epicor administrator if you do not know this value.
    * **ERP Instance**—the name of your ERP company instance. This value appears as the first path segment in your Epicor Kinetic URL. For example, in [https://example123.developer.epicor.com/EPIC06/](https://example123.developer.epicor.com/EPIC06/), the ERP instance is *EPIC06*. Contact your Epicor administrator if you are unsure.
    * **Service**—the fully qualified name of the service you want to retrieve data from. For example, *erp.bo.CustomerSvc*, *erp.bo.GLAccountSvc*, *erp.bo.SalesOrderSvc*, *erp.bo.JournalEntrySvc*, or *BAQsvc*.

    <Tip>
      To discover the services available on your instance, append `/api/help` to your instance URL. For example, `https://{instance_id}.developer.epicor.com/{instance}/api/help`. For a complete reference, see the [Epicor REST Services Guide](https://epicweb.epicor.com/doc/Docs/Kinetic_RESTServicesGuideV2_2023.1.pdf).
    </Tip>
  </Step>

  <Step>
    Choose an **Auth Scheme** from the list.
  </Step>

  <Step>
    If you choose **Basic**, enter the following information:

    * **User**—the Epicor Kinetic username for authentication
    * **Password**—the user password
  </Step>

  <Step>
    If you choose **AzureADOpenID**, enter the **Azure Tenant**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Epicor Kinetic, see [this information page](https://cdn.cdata.com/help/UEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Exact Online
Source: https://docs.cloud.cdata.com/en/Data-Sources/ExactOnline



<Note>
  You cannot sign in to Exact Online with embedded credentials. Please create a custom OAuth application to sign in instead. See below.
</Note>

## Prerequisites

Before connecting Exact Online to Connect AI, you must create a custom OAuth application in the Exact Online App Center:

<Steps>
  <Step>
    If you have not already done so, create an Exact Online developer account.
  </Step>

  <Step>
    Log in to the App Center.
  </Step>

  <Step>
    Navigate to **Manage Apps** > **Add a New Application**.
  </Step>

  <Step>
    Enter a name for the application.
  </Step>

  <Step>
    Set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Edit**. The App Center displays your new application's client ID and client secret. Save this information.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Exact Online to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Exact Online* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a region in the **Region** drop-down list that is associated with your Exact Online administration.
  </Step>

  <Step>
    On the **Advanced Settings** tab, enter the **OAuthClientId** and **OAuthClientSecret** values from the custom OAuth application you created in the Prerequisites section.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Exact Online sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Exact Online account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    The **Division** field populates with the divisions associated with your Exact Online administration. Select a division from the drop-down list. The default value is the first division in the list.
  </Step>

  <SaveAndTest title="Exact Online" />
</Steps>

## More Information

For more information about interactions between Connect AI and Exact Online, see [this information page](https://cdn.cdata.com/help/DYM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Excel for the web
Source: https://docs.cloud.cdata.com/en/Data-Sources/ExcelOnline



## Setup Guide

Follow these steps to connect Excel for the web to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Excel for the web* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Sharepoint URL** to connect to Excel files on a SharePoint site. Leave this field blank to connect to Excel files on your OneDrive.
      </Step>

      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Excel for the web sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Excel for the web account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter the **OAuth Client Id**, which is the client Id assigned when you register your Excel for the web account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Excel for the web account.
      </Step>

      <Step>
        Enter the **Sharepoint URL** field to connect to Excel files on a SharePoint site. Leave blank to connect to Excel files on your OneDrive.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter the **OAuth Client Id**, which is the client Id assigned when you register your Excel for the web account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert** for your Excel for the web account in the format shown.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert Password** for your Excel for the web account, if required.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert Subject** for your Excel for the web account. This is the subject of the OAuth JWT certificate. If omitted, the first certificate in the certificate store is used.
      </Step>

      <Step>
        Enter the **Sharepoint URL** field to connect to Excel files on a SharePoint site. Leave blank to connect to Excel files on your OneDrive.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Issue Queries

In some configurations of Excel for the web, tables are accessible under the schema name OneDrive instead of ExcelOnline. For example, when querying a Excel for the web table, the fully-qualified table name might be `[ExcelOnline1].[OneDrive].[TableName]`. You can use [Data Explorer](/en/Data-Explorer) to view your schemas to see if this applies to your configuration.

## More Information

For more information about interactions between Connect AI and Excel for the web, see [this information page](https://cdn.cdata.com/help/FXM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Excel Services
Source: https://docs.cloud.cdata.com/en/Data-Sources/ExcelServices



## Setup Guide

Follow these steps to connect Excel Services to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Excel Services* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** for the SharePoint site or site collection the provider connects to, for example, *[http://server/SharePoint/](http://server/SharePoint/)*.
  </Step>

  <Step>
    Enter the **File** name of the Excel file to connect to, including the `.xlsx` extension.
  </Step>

  <Step>
    Select the **Share Point Version** that matches the SharePoint server you are connecting to. Supported values are **SharePoint 2013** and **SharePoint 2010**. The default value is **SharePoint 2013**.
  </Step>

  <Step>
    (Optional) Enter the **Folder** path within the document library where the file specified in the **File** field is located.
  </Step>

  <Step>
    (Optional) Enter the **Library** name of the SharePoint document library that contains the Excel file you want to connect to. The Shared Documents library is used by default.
  </Step>

  <Step>
    (Optional) Set **Use RESTAPI** to specify whether the provider uses the SharePoint REST API instead of the OData API to retrieve data. The default value is **True**.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="NTLM">
    <Steps>
      <Step>
        Enter the **User** name for the account used to authenticate to the SharePoint server.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User** name for the account used to authenticate to the SharePoint server.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Digest">
    <Steps>
      <Step>
        Enter the **User** name for the account used to authenticate to the SharePoint server.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Forms">
    <Steps>
      <Step>
        Enter the **User** name for the account used to authenticate to the SharePoint server.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this authentication method.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    <Steps>
      <Step>
        Enter the **User** name for the account used to authenticate to the SharePoint server.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** name used to authenticate.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **STSURL**, the URL of the security token service (STS) used for single sign-on (SSO) with ADFS.
      </Step>

      <Step>
        Enter the **SSO Login URL** for the identity provider.
      </Step>

      <Step>
        Enter the **SSO Domain** associated with the user account.
      </Step>

      <Step>
        (Optional) Enter the **SSO Properties** required to connect to the identity provider, formatted as a semicolon-separated list (for example, `SSOProperty1=value1;SSOProperty2=value2;`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Excel Services, see [this information page](https://cdn.cdata.com/help/DTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Exchange
Source: https://docs.cloud.cdata.com/en/Data-Sources/Exchange



## Setup Guide

Follow these steps to connect Exchange to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Exchange* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Specify the Exchange **Schema** to connect to. MSGraph is the recommended schema for Exchange.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Exchange sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Exchange account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter the **Azure Tenant** Id being used to access data. This value is the directory Id in the **Azure Portal** > **Azure Active Directory** > **Properties**.
      </Step>

      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Exchange sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Exchange account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your application with an OAuth authorization server.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned when you registered your application with an OAuth authorization server.
      </Step>

      <Step>
        (Optional) Enter the **Azure Tenant** Id being used to access data. This value is the directory Id in the **Azure Portal** > **Azure Active Directory** > **Properties**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your Exchange account for OAuth.
        * **OAuth JWT Cert**—the contents of the public key you generated.
        * **OAuth JWT Cert Type**—the type of key store containing the OAuth JWT certificate.
        * **Azure Tenant**—(optional) the tenant Id used to access data. This value is the directory Id in the **Azure Portal** > **Azure Active Directory** > **Properties**.
        * **OAuth JWT Cert Subject**—(optional) the subject of the OAuth JWT certificate. The default value is the first certificate in the certificate store.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Exchange, see [this information page](https://cdn.cdata.com/help/CEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# FHIR
Source: https://docs.cloud.cdata.com/en/Data-Sources/FHIR



## Setup Guide

Follow these steps to connect FHIR to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *FHIR* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set your **Connection Type**. The connection type determines the authentication method you will use.
  </Step>
</Steps>

## Generic Authentication Methods

<Tabs>
  <Tab title="GenericOAuth">
    The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the Id assigned when you registered your FHIR account.
        * **OAuth Client Secret**—the client secret for your FHIR account.
        * **OAuth Authorization URL**—the URL where the user logs into OAuth and grants permissions to the application.
        * **OAuth Access Token URL**—the URL where authorization tokens can be exchanged for access tokens.
        * **URL**—the URL of the FHIR server. A sample generic URL is as follows: `http://my_fhir_server/r4b/`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the FHIR sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your FHIR account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>
        Enter the **URL** for your connection. A sample generic URL is as follows: `http://my_fhir_server/r4b/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Azure Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the URL of the FHIR server. A sample Azure URL is as follows: `https://MY_AZURE_FHIR.azurehealthcareapis.com/`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the FHIR sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your FHIR account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the Id assigned when you registered your FHIR account.
        * **OAuth Client Secret**—the client secret for your FHIR account.
        * **URL**—the URL of the FHIR server. A sample Azure URL is as follows: `https://MY_AZURE_FHIR.azurehealthcareapis.com/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## AWS Authentication Methods

Enter an **AWS Region**, and then select an **Auth Scheme**.

<Tabs>
  <Tab title="AwsRootKeys">
    <Steps>
      <Step>
        Enter the following information:

        * **AWS Access Key**—your AWS account access key. This value is found in your AWS security credentials page.
        * **AWS Secret Key**—your AWS account secret key. This value is found in your AWS security credentials page.
        * **URL**—the URL of the FHIR server. A sample AWS URL is as follows: `https://healthlake.REGION.amazonaws.com/datastore/DATASTORE_ID/r4/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AwsIAMRoles">
    <Steps>
      <Step>
        Enter the following information:

        * **AWS Access Key**—your AWS account access key. This value is found in your AWS security credentials page.
        * **AWS Secret Key**—your AWS account secret key. This value is found in your AWS security credentials page.
        * **AWS Role ARN**—the Amazon Resource Name of the role you want to use when authenticating.
        * **URL**—the URL of the FHIR server. A sample AWS URL is as follows: `https://healthlake.REGION.amazonaws.com/datastore/DATASTORE_ID/r4/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Google Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **URL** of the FHIR server. A sample Google URL is as follows: `https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/`.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the FHIR sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your FHIR account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth JWT Cert**—the contents of the certificate file provided by Google. A sample format is provided.
        * **OAuth JWT Subject**—(optional) the email address of the user whose data you want to access. Only set this value if the service account is part of a GSuite domain and you want to enable delegation.
        * **URL**—the URL of the FHIR server. A sample Google URL is as follows: `https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## InterSystems Authentication Methods

<Tabs>
  <Tab title="ApiKey">
    <Steps>
      <Step>
        Enter the **API Key** for your FHIR account.
      </Step>

      <Step>
        Enter the **URL** of the FHIR server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>
        Enter the **URL** of the FHIR server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and FHIR, see [this information page](https://cdn.cdata.com/help/KIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# FTP
Source: https://docs.cloud.cdata.com/en/Data-Sources/FTP



## Setup Guide

Follow these steps to connect FTP to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *FTP* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Remote Host**, which is the hostname or IP address of the FTP server.
  </Step>

  <Step>
    Enter the **User**, which is the username for authenticating to the FTP server.
  </Step>

  <Step>
    Enter the **Password** for the FTP user account.
  </Step>

  <Step>
    (Optional) Enter the **Remote Port**, which is the network port used to connect to the FTP server.
  </Step>

  <Step>
    (Optional) Enter the **Remote Path**, which is the working directory path on the FTP server.
  </Step>

  <Step>
    (Optional) Select an **SSL Mode** to specify the SSL/TLS negotiation mode used when connecting to the FTP server. Supported values are **AUTOMATIC**, **NONE**, **IMPLICIT**, and **EXPLICIT**. The default value is **AUTOMATIC**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Facebook
Source: https://docs.cloud.cdata.com/en/Data-Sources/Facebook



## Setup Guide

Follow these steps to connect Facebook to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Facebook* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) If you need to access data provided by an earlier **Version** of the Facebook API, enter it here.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Facebook sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Facebook account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Facebook, see [this information page](https://cdn.cdata.com/help/RBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Facebook Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/FacebookAds



## Setup Guide

Follow these steps to connect Facebook Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Facebook Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Facebook Ads sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Facebook Ads account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    The **Account Id** field populates with your account Ids. Select an account Id from the drop-down list. The default value is the first account Id.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Facebook Ads, see [this information page](https://cdn.cdata.com/help/HRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Certinia
Source: https://docs.cloud.cdata.com/en/Data-Sources/FinancialForce



## Prerequisites

The **OAuth**, **OAuthClient**, **OAuthPassword**, and **AzureAD** authentication methods require a custom OAuth application. The default **OAuthPKCE** method uses CData's embedded OAuth application, so you can skip this section if you are using it.

To create a custom OAuth application in Certinia, follow these steps:

<Steps>
  <Step>
    Log in to your Salesforce org (the org where Certinia is installed) and navigate to **Setup**. In the **Quick Find** box, search for *Apps*, then click **New Connected App**.
  </Step>

  <Step>
    Enter a **Connected App Name** (the display name shown on the authentication dialog) and a **Contact Email**.
  </Step>

  <Step>
    Under **API (Enable OAuth Settings)**, select **Enable OAuth Settings** and set the **Callback URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Select the **OAuth scopes** that your application should request from the user, then **Save** the application.
  </Step>

  <Step>
    Open the connected app's settings to retrieve the **Consumer Key** (your **OAuth Client Id**) and **Consumer Secret** (your **OAuth Client Secret**). For the **OAuth**, **OAuthPassword**, and **AzureAD** methods, you enter these values in Connect AI when configuring the connection. The **OAuthClient** method requires the custom app to exist but provides no fields to enter these values.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Certinia to your Connect AI account:

<Steps>
  <Step>
    On the **Basic Settings** tab of the Certinia connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Certinia sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Certinia account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Certinia username for authentication.
      </Step>

      <Step>
        Enter the user **Password**.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Certinia sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Certinia account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        This method requires a custom OAuth application (see the [Prerequisites](#prerequisites) section), but there are no additional fields to complete in Connect AI.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the Certinia username for authentication.
      </Step>

      <Step>
        Enter the user **Password**.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        This authentication method requires no additional fields.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OneLogin">
    <Steps>
      <Step>
        Enter the OneLogin **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the Salesforce account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and then choosing the desired organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the PingFederate **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and then choosing the desired organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and choosing the desired organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and then choosing the desired organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and then choosing the desired organization.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Certinia sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Certinia account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Certinia, see [this information page](https://cdn.cdata.com/help/HFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Freshdesk
Source: https://docs.cloud.cdata.com/en/Data-Sources/FreshDesk



## Setup Guide

Follow these steps to connect Freshdesk to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Freshdesk* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain** for your Freshdesk account. When you are logged into Freshdesk, the domain is displayed in the URL as `https://[domainValue].freshdesk.com`.
  </Step>

  <Step>
    Enter the **API Key** associated with your Freshdesk account. To obtain this, log in to your support portal and open your profile settings page. The API key appears below the **Change Password** section.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Freshdesk, see [this information page](https://cdn.cdata.com/help/GFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# GMO MakeShop
Source: https://docs.cloud.cdata.com/en/Data-Sources/GMOMakeShop



## Setup Guide

Follow these steps to connect GMO MakeShop to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *GMO MakeShop* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Members Access Code, Products Access Code, Orders Access Code**—the access codes from your GMO MakeShop store account to access the orders API
    * **Shop Id**—the store account Id of your GMO MakeShop store
    * **Member Authentication Code**—the authentication code from your GMO MakeShop store account to access the MemberAuthenticationConfirm stored procedure
    * **Password**—the password for your GMO MakeShop account
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and GMO MakeShop, see [this information page](https://cdn.cdata.com/help/SMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Garoon
Source: https://docs.cloud.cdata.com/en/Data-Sources/Garoon



## Setup Guide

Follow these steps to connect Garoon to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Garoon* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **URL**—the URL for your Garoon account. Here are accepted URL format for supported versions:
      * Cloud version : https\://(subdomain).cybozu.com (default)
      * Package version (Windows environment) : http\://(server IP address or host name)/scripts/(installation identifier)/grn.exe
      * Package version (Linux environment) : http\://(server IP address or host name)/cgi-bin/(installation identifier)/grn.cgi
    * **User**—the user Id of the authenticating Garoon user account.
    * **Password**—the password of the authenticating Garoon user account.
    * **Basic Auth User**—the additional username required for domains using basic authentication.
    * **Basic Auth Password**—the additional password required for domains using basic authentication.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Garoon, see [this information page](https://cdn.cdata.com/help/URM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# GitHub
Source: https://docs.cloud.cdata.com/en/Data-Sources/GitHub



## Setup Guide

Follow these steps to connect GitHub to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *GitHub* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        (Optional) To restrict repositories and projects to a specific owner, enter the **Owner Login**. This is either the user name for an individual account or a login name associated with an organization account.
      </Step>

      <Step>
        Enter the base **URL** for the GitHub environment you are connecting to. This is required if connecting to a GitHub Enterprise Server instance or a GitHub Enterprise Cloud environment that uses a non-standard API domain. For connections to the standard GitHub service (including GitHub Enterprise Cloud accounts using the default API endpoint), this property must be left empty.
      </Step>

      <Step>
        (Optional) To restrict access to a certain schema, enter the **Schema** that the user has access to. By default, the user has access to all schemas.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the GitHub sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your GitHub account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PersonalAccessToken">
    <Steps>
      <Step>
        Enter your GitHub Personal Access Token in the **Token** field.

        To obtain a token, log in to your GitHub account, navigate to **Settings** > **Developer settings** > **Personal access tokens**, and click **Generate new token**. Select the required scopes and click **Generate token**. Copy and save the generated token, as it will only be shown once.
      </Step>

      <Step>
        (Optional) To restrict repositories and projects to a specific owner, enter the **Owner Login**. This is either the user name for an individual account or a login name associated with an organization account.
      </Step>

      <Step>
        Enter the base **URL** for the GitHub environment you are connecting to. This is required if connecting to a GitHub Enterprise Server instance or a GitHub Enterprise Cloud environment that uses a non-standard API domain. For connections to the standard GitHub service (including GitHub Enterprise Cloud accounts using the default API endpoint), this property must be left empty.
      </Step>

      <Step>
        (Optional) To restrict access to a certain schema, enter the **Schema** that the user has access to. By default, the user has access to all schemas.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and GitHub, see [this information page](https://cdn.cdata.com/help/FGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Gmail
Source: https://docs.cloud.cdata.com/en/Data-Sources/Gmail



## Setup Guide

Follow these steps to connect Gmail to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Gmail* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Confirm your **Schema** in the drop down.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Gmail account.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Gmail account.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Gmail sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Gmail account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJwt">
    <Steps>
      <Step>
        Enter your **OAuth JWT Cert**. This is a multi-line key.
      </Step>

      <Step>
        Enter your **OAuth JWT Subject**. This must be set to the email address of the user whose data you want to access. The account must also be part of a GSuite domain.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Gmail, see [this information page](https://cdn.cdata.com/help/DLM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleAds



## Setup Guide

Follow these steps to connect Google Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the developer token for your Google Ads account in the **Developer Token** field. If you do not have a developer token, see [this article](https://developers.google.com/google-ads/api/first-call/dev-token) for instructions.
  </Step>

  <Step>
    Enter your **Client Customer Id**. You can find this at the bottom of the help menu in the Google Ads UI.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Ads sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Ads account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT Cert**. This is a multi-line key.
      </Step>

      <Step>
        Enter your **OAuth JWT Subject**. This must be set to the email address of the user whose data you want to access. The account must also be part of a GSuite domain.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Ads, see [this information page](https://cdn.cdata.com/help/DZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Ad Manager
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleAdsManager



## Setup Guide

Follow these steps to connect Google Ad Manager to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Ad Manager* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Choose an **Auth Scheme** and continue with the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **Network Code**—this value appears in the URL after you log in to the network. For example, in the URL `https://www.google.com/dfp/1234567#delivery`, 1234567 is your network code.
        * **Version**—the latest Google Ad Manager Api version
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Ad Manager sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Ad Manager account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **Network Code**—this value appears in the URL after you log in to the network. For example, in the URL `https://www.google.com/dfp/1234567#delivery`, 1234567 is your network code.
        * **Version**—the latest Google Ad Manager Api version
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Ad Manager, see [this information page](https://cdn.cdata.com/help/BDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Analytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleAnalytics



## Setup Guide

Follow these steps to connect Google Analytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Analytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Select your **Schema**. The options are `GoogleAnalytics4` or `UniversalAnalytics`.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Analytics sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Analytics account.
      </Step>

      <Step>
        Click **Continue** to grant the requested permissions.

        <Note>
          Each permission is required for the connection to function.
        </Note>
      </Step>

      <Step>
        If you selected `GoogleAnalytics4` as the schema, the **Property Id** field populates with your property Ids. Select a property Id from the drop-down list. The default value is the first property Id. You can also enter a custom value.
      </Step>

      <Step>
        If you selected `UniversalAnalytics` as the schema, enter your **Profile** and select your **API version**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT Cert**. This is a multi-line key in the format shown.
      </Step>

      <Step>
        Enter your **OAuth JWT Subject**. This must be set to the email address of the user whose data you want to access. The account must also be part of a GSuite domain.
      </Step>

      <Step>
        Select your **Schema**. The options are `GoogleAnalytics4` and `UniversalAnalytics`.
      </Step>

      <Step>
        (Optional) In the **Property Id** field, enter the Google Analytics profile that you want to use. If you leave this field blank, the connection uses the first returned profile.
      </Step>

      <Step>
        If you selected `GoogleAnalytics4` as the schema, enter the **Property Id**.
      </Step>

      <Step>
        If you selected `UniversalAnalytics` as the schema, enter your **Profile** and select your **API version**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Analytics, see [this information page](https://cdn.cdata.com/help/DAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Campaign Manager
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleCM



## Setup Guide

Follow these steps to connect Google Campaign Manager to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Campaign Manager* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        In the **Profile Id** field of the **Authentication** section, enter the DoubleClick User Profile ID to connect to. If you do not specify a Profile ID, the first user profile returned is used.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Campaign Manager sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Campaign Manager account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        In the **Profile Id** field of the **Authentication** section, enter the DoubleClick User Profile ID to connect to. If you do not specify a Profile ID, the first user profile returned is used.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Campaign Manager, see [this information page](https://cdn.cdata.com/help/EPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Calendar
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleCalendar



## Setup Guide

Follow these steps to connect Google Calendar to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Calendar* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Calendar sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Calendar account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth JWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT Cert**. This is multi-line and in PEM format.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**.
      </Step>

      <Step>
        (Optional) Enter an **OAuth JWT Cert Password**. This only needs to be done if the certificate is encrypted.
      </Step>

      <Step>
        (Optional) If required, add an **OAuth JWT Cert Subject**.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Issuer**. This must include the client\_id or connected app for the which the certificate is registered.
      </Step>

      <Step>
        (Optional) Enter an **OAuth JWT Subject**. It must be formatted as an email address.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Calendar, see [this information page](https://cdn.cdata.com/help/EGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Cloud Storage
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleCloudStorage



## Setup Guide

Follow these steps to connect Google Cloud Storage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Cloud Storage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **Project Id** field, enter the Id of the project where your Google Cloud Storage instance resides. To find this value, open the Google Cloud Console and click the project name in the upper-left corner. The project Id appears in the **ID** column of the matching project.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Cloud Storage sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Cloud Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth JWT">
    <Steps>
      <Step>
        This authentication method requires no additional fields.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWS Workload Identity">
    <Steps>
      <Step>
        Enter the **AWS Workload Identity Config**, the configuration properties to provide when using Workload Identity Federation via AWS.
      </Step>

      <Step>
        Enter the **Workload Pool Id**, the Id of your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Project Id**, the Id of the Google Cloud project that hosts your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Provider Id**, the Id of your Workload Identity Federation pool provider.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Azure Workload Identity">
    <Steps>
      <Step>
        Enter the **Azure Workload Identity Config**, the configuration properties to provide when using Workload Identity Federation via Azure.
      </Step>

      <Step>
        Enter the **Workload Pool Id**, the Id of your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Project Id**, the Id of the Google Cloud project that hosts your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Provider Id**, the Id of your Workload Identity Federation pool provider.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Cloud Storage, see [this information page](https://cdn.cdata.com/help/HPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Contacts
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleContacts



## Setup Guide

Follow these steps to connect Google Contacts to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Contacts* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Contacts sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Contacts account.
      </Step>

      <Step>
        Select the checkboxes next to each permission category and click **Continue** to grant the requested permissions.

        <Note>
          Each permission is required for the connection to function.
        </Note>
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information.

        * **OAuth JWT Cert**—Enter the content of the JSON certificate provided by Google.
        * (Optional) **OAuth JWT Subject**—Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Contacts, see [this information page](https://cdn.cdata.com/help/ECM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Directory
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleDirectory



## Setup Guide

Follow these steps to connect Google Directory to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Directory* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Directory sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Directory account.
      </Step>

      <Step>
        Select the checkboxes next to each permission category and click **Continue** to grant the requested permissions.

        <Note>
          Each permission is required for the connection to function.
        </Note>
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Directory, see [this information page](https://cdn.cdata.com/help/EUM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Drive
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleDrive



## Setup Guide

Follow these steps to connect Google Drive to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Drive* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Oauth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Drive sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Drive account.
      </Step>

      <Step>
        Click **Continue** to grant the requested permissions.

        <Note>
          Each permission is required for the connection to function.
        </Note>
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Oauth JWT">
    <Steps>
      <Step>
        Enter the **OAuth JWT Cert** provided by Google. This is a multi-line key.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Subject** if your services account is part of a GSuite domain and you want to enable delegation.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Drive, see [this information page](https://cdn.cdata.com/help/RGK/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Search
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleSearch



## Setup Guide

Follow these steps to connect Google Search to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Search* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Custom Search Id**. You must sign into the Google Custom Search engine and create a new engine to obtain this Id.
  </Step>

  <Step>
    Enter the **API Key**. To obtain this you must enable the Custom Search API in the Google API Console.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Google Search, see [this information page](https://cdn.cdata.com/help/BLM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Sheets
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleSheets



## Setup Guide

Follow these steps to connect Google Sheets to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Sheets* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Token">
    <Steps>
      <Step>
        Enter the **API Key** for your Google Cloud account. You can create an API key in the Google Cloud Console by clicking **Create credentials > API key**.
      </Step>

      <Step>
        (Optional) To improve performance, fill out either the **Spreadsheet** field with a comma separated list of sheet names or Ids or enter a **Folder Name**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        (Optional) To improve performance, fill out either the **Spreadsheet** field with a comma separated list of sheet names or Ids or enter a **Folder Name**.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Sheets sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Sheets account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the OAuth JWT Cert. This is multi-line and should be in the following format:

        ```json theme={null}
        {
          "type": "service_account",
          "project_id": "...",
          "private_key_id": "...",
          "private_key": "...",
          "client_email": "...",
          "client_id": "...",
          "auth_uri": ...",
          "token_uri": "...",
          "auth_provider_x509_cert_url": "...",
          "client_x509_cert_url": "..."
        }
        ```
      </Step>

      <Step>
        (optional) Set the **OAuthJWT Cert Subject**. Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.
      </Step>

      <Step>
        (Optional) To improve performance, fill out either the **Spreadsheet** field with a comma separated list of sheet names or Ids or enter a **Folder Name**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Sheets, see [this information page](https://cdn.cdata.com/help/RLM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Spanner
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleSpanner



## Setup Guide

Follow these steps to connect Google Spanner to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Spanner* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Database Dialect**. This is the dialect type of the connected database. The default value is correct for most connections.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **Project Id**—the ID of the project where your Google Spanner instance resides.
        * **Database**—the name of the database.
        * **Instance Id**—the ID of the Google Spanner instance to which you are connecting.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Spanner sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Spanner account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuthJWT Cert**—the content of the JSON certificate provided by Google.
        * **OAuthJWT Subject**—(optional) a subject value is required if the service account is part of a GSuite domain and you want to enable delegation.
        * **Project Id**—the ID of the project where your Google Spanner instance resides.
        * **Database**—the name of the database.
        * **Instance Id**—the ID of the Google Spanner instance to which you are connecting.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Spanner, see [this information page](https://cdn.cdata.com/help/OGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# GraphQL
Source: https://docs.cloud.cdata.com/en/Data-Sources/GraphQL



## Setup Guide

Follow these steps to connect GraphQL to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *GraphQL* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of your GraphQL service.
  </Step>

  <Step>
    If you do not need authentication, select **None** in the **Auth Scheme** drop-down list. Otherwise, select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the GraphQL username for authentication into **User**.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your GraphQL account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your GraphQL account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Authorization URL** where the user logs into the service.
      </Step>

      <Step>
        Enter the **OAuth Access Token URL** where the request for the access token is made.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the GraphQL sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your GraphQL account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your GraphQL account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Authorization URL** where the user logs into the service.
      </Step>

      <Step>
        Enter the **OAuth Access Token URL** where the request for the access token is made.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and GraphQL, see [this information page](https://cdn.cdata.com/help/LAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Greenhouse
Source: https://docs.cloud.cdata.com/en/Data-Sources/Greenhouse



## Setup Guide

Follow these steps to connect Greenhouse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Greenhouse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** for your Greenhouse account. To create an API key, follow the steps below.

    a. Click the **Configure** icon in the navigation bar and locate **Dev Center** on the left.

    b. Select **API Credential Management**.

    c. Click **Create New API Key**.
    d. Set "API Type" to **Harvest**.

    e. Set "Partner" to **custom**.

    f. Optionally, provide a description.

    g. Proceed to **Manage permissions** and select the appropriate permissions based on the resources you want to access through the driver.

    h. Copy and paste the created API Key.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Greenplum
Source: https://docs.cloud.cdata.com/en/Data-Sources/Greenplum



## Setup Guide

Follow these steps to connect Greenplum to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Greenplum* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Password**—enter the user password.
    * **User**—enter the Greenplum username for authentication.
    * **Port**—enter the port for connecting to the Greenplum server. This is set to 5432 by default.
    * **Server**—enter the host name or IP address of the Greenplum server.
    * **Database**—(Optional) enter the name of the database to connect to. If left blank, the user's default database is used.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Greenplum, see [this information page](https://cdn.cdata.com/help/SGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# HDFS
Source: https://docs.cloud.cdata.com/en/Data-Sources/HDFS



## Setup Guide

Follow these steps to connect HDFS to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *HDFS* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Host**, which specifies the host of your HDFS installation.
  </Step>

  <Step>
    Enter the **Port** of your HDFS installation. The default is 9870.
  </Step>

  <Step>
    (Optional) Enter the **Path**, which specifies the HDFS path used as the working directory.
  </Step>

  <Step>
    Select the **Auth Scheme** used for authentication, then proceed to the relevant section below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="None">
    <Steps>
      <Step>
        (Optional) Enter the **User**, which is the user name used to log in to the HDFS server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    <Steps>
      <Step>
        (Optional) Enter the **User**, which is the user name used to log in to the HDFS server.
      </Step>

      <Step>
        (Optional) Enter the **Password** used to authenticate to the HDFS server. This is only used when Kerberos authentication is selected.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the **Access Token**, which is the HDFS access token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and HDFS, see [this information page](https://cdn.cdata.com/help/GWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Highrise
Source: https://docs.cloud.cdata.com/en/Data-Sources/Highrise



## Setup Guide

Follow these steps to connect Highrise to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Highrise* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **AccountId** of the currently authenticated user.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth2">
    The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Highrise sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Highrise account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIToken">
    <Steps>
      <Step>
        Enter the **API Token** of the currently authenticated user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Highrise, see [this information page](https://cdn.cdata.com/help/BHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# HubDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/HubDB



## Prerequisites

The **OAuth** authentication method requires a custom OAuth application created in HubSpot. If you are connecting with the **PrivateApp** method, you can skip this section.

To create a custom OAuth application, follow these steps:

<Steps>
  <Step>
    Sign in to your HubSpot developer account. If you do not have one, create a developer account at [developers.hubspot.com](https://developers.hubspot.com/).
  </Step>

  <Step>
    Navigate to **Apps** and click **Create app**.
  </Step>

  <Step>
    On the **Auth** tab, record the **Client ID** and **Client secret**. You enter these values as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>

  <Step>
    In the **Redirect URLs** field, enter the Connect AI callback URL `https://oauth.cdata.com/oauth/`.
  </Step>

  <Step>
    Under **Scopes**, add the scopes your application needs to access HubDB data, then save your application.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect HubDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *HubDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select your **Auth Scheme** and follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—Set to the client ID (also known as the consumer key) assigned to your custom OAuth application.
        * **OAuth Client Secret**—Set to the client secret assigned to your custom OAuth application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the HubDB sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your HubSpot account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PrivateApp">
    Enter your HubSpot Private App Token in the **Private App Token** field.

    You can generate a HubSpot Private App Token by following the steps below.

    <Steps>
      <Step>
        In your HubSpot account, click the **Settings** icon in the main navigation bar.
      </Step>

      <Step>
        In the left sidebar menu, navigate to **Integrations > Private Apps**.
      </Step>

      <Step>
        Click **Create private app**.
      </Step>

      <Step>
        On the **Basic Info** tab, configure the details of your application (name, logo, and description).
      </Step>

      <Step>
        On the **Scopes** tab, select **Read** or **Write** for each scope you want your private application to be able to access. This determines the data the connector has access to retrieve.
      </Step>

      <Step>
        After you are done configuring your application, click **Create app** in the top right. Review the information about your application's access token, click **Continue creating**, and then **Show token**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# HubSpot
Source: https://docs.cloud.cdata.com/en/Data-Sources/HubSpot



## Setup Guide

Follow these steps to connect HubSpot to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *HubSpot* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select which **Schema** to connect to.
  </Step>

  <Step>
    If your **Schema** is **HubSpotV3**, you can choose to **Expand Associations** and/or **Include Custom Tables**. Note that in the **HubSpotV3** schema, certain tables are only accessible using the **PrivateAppToken** authentication method.
  </Step>

  <Step>
    Select your **Auth Scheme** and follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the HubSpot sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your HubSpot account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PrivateAppToken">
    Enter the Hubspot Private App Token in the **OAuth Access Token** field.

    You can generate a HubSpot Private App Token by following the steps below.

    <Steps>
      <Step>
        In your HubSpot account, click the **Settings** icon in the main navigation bar.
      </Step>

      <Step>
        In the left sidebar menu, navigate to **Integrations > Private Apps**.
      </Step>

      <Step>
        Click **Create private app**.
      </Step>

      <Step>
        On the **Basic Info** tab, configure the details of your application (name, logo, and description).
      </Step>

      <Step>
        On the **Scopes** tab, select **Read** or **Write** for each scope you want your private application to be able to access. This determines the data the driver has access to retrieve.
      </Step>

      <Step>
        After you are done configuring your application, click **Create app** in the top right. Review the information about your application's access token, click **Continue creating**, and then **Show token**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and HubSpot, see [this information page](https://cdn.cdata.com/help/DHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# IBM Cloud Object Storage
Source: https://docs.cloud.cdata.com/en/Data-Sources/IBMCloudObjectStorage



## Setup Guide

Follow these steps to connect IBM Cloud Object Storage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *IBM Cloud Object Storage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication

<Steps>
  <Step>
    Enter the **Api Key**, which is used to identify the user to IBM Cloud. Create an API key by navigating to **Manage > Access (IAM) > Users** and clicking **Create**.
  </Step>

  <Step>
    (Optional) Enter the **Cloud Object Storage CRN**, which uniquely identifies your Cloud Object Storage instance in IBM Cloud (for example, *crn:v1:bluemix:public:cloud-object-storage:\[region\_id]:a/\[account\_id]:\[guid]*). To retrieve your **Cloud Object Storage CRN**, select your Cloud Object Storage instance from the Dashboard. Click the **Service credentials** tab on the right side and click **View credentials.**
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and IBM Cloud Object Storage, see [this information page](https://cdn.cdata.com/help/GMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# IBM Informix
Source: https://docs.cloud.cdata.com/en/Data-Sources/Informix



## Setup Guide

Follow these steps to connect IBM Informix to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *IBM Informix* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme**. Choose EUSRIDPWD to authenticate with an encrypted user Id and password.
  </Step>

  <Step>
    Enter the following information:

    * **User**—the IBM Informix username for authentication
    * **Password**—the user password
    * **Database**—the name of the database to connect to
    * **Port**—the port for connecting to the IBM Informix server
    * **Server**—the host name or IP address of the IBM Informix server
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and IBM Informix, see [this information page](https://cdn.cdata.com/help/JIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Instagram
Source: https://docs.cloud.cdata.com/en/Data-Sources/Instagram



## Prerequisites

If you choose to create a custom OAuth application in the Meta Developer Portal (optional), follow these steps:

<Note>
  Before you begin, make sure your Instagram account is a Business or Creator account that is connected to a Facebook Page. You must have a role on the Page that is associated with the Instagram account.
</Note>

<Steps>
  <Step>
    Go to the [Meta Developer Portal](https://developers.facebook.com/apps). Sign in with your Facebook account (or create one if you do not already have one).
  </Step>

  <Step>
    Register the application.

    * Click **Create App** and follow the prompts to create a new app.
    * After the app is created, go to **Settings** > **Basic**. The **App ID** and **App Secret** shown here are the values you will enter as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
    * Click **Add Platform** and select **Website**. Enter a **Site URL** for your application.
  </Step>

  <Step>
    Add and configure the Facebook Login product.

    * From the left navigation, click **Add Product** and add **Facebook Login**.
    * Under **Facebook Login** > **Settings**, in **Valid OAuth Redirect URIs**, enter the redirect URI used by Connect AI: *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
    * Save your changes.
  </Step>

  <Step>
    Add the Instagram product.

    * From the left navigation, click **Add Product** and add **Instagram**.
  </Step>

  <Step>
    Submit your app for review.

    * Click **App Review** > **Permissions and Features**, then click **Request Advanced Access** for the following permissions: **instagram\_basic**, **instagram\_manage\_comments**, and **instagram\_manage\_insights**.
    * Provide the information Meta requires and submit the request. You must wait for Meta to approve the permissions before you can use the custom OAuth app to connect production Instagram accounts.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Instagram to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Instagram* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) **Enter a Business Account Id**. This is only required if you have more than one Instagram business account associated with one Facebook Account.
  </Step>

  <Step>
    (Optional) If you are using a custom OAuth application to connect, click **Advanced Settings** and enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the prerequisites.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Instagram sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Instagram account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Instagram, see [this information page](https://cdn.cdata.com/help/ENM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Jira
Source: https://docs.cloud.cdata.com/en/Data-Sources/JIRA



## Setup Guide

Follow these steps to connect Jira to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Jira* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** to your Jira endpoint.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Jira sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Jira account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIToken">
    <Steps>
      <Step>
        Enter the Jira username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the Jira **API token** for the username that you enter in the **User** field.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Jira username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Crowd">
    <Steps>
      <Step>
        Enter the Jira username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL** associated with the Crowd account. You can find the IDP URL by navigating to **your application > SSO > SSO information > Identity provider single sign-on URL**.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** used to exchange the SAML token for Jira cookies. This URL can have the following format: `https://<authority of Jira instance>/plugins/servlet/samlsso`.
      </Step>

      <Step>
        Enter the **SSO App Name** of the application.
      </Step>

      <Step>
        Enter the **SSO App Password** of the application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Jira username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        Enter all relevant property-value pairs into the **SSO Properties** field with the format `ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;`. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** used to exchange the SAML token for Jira cookies. This URL can have the following format: `https://<authority of Jira instance>/plugins/servlet/samlsso`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="LDAP">
    <Steps>
      <Step>
        Enter the Jira username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Jira, see [this information page](https://cdn.cdata.com/help/BJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# JSON
Source: https://docs.cloud.cdata.com/en/Data-Sources/JSON



## Setup Guide

Follow these steps to connect JSON to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *JSON* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI** for the JSON resource location.
  </Step>

  <Step>
    Select the **Data Model** to use when parsing JSON documents. Options are as follows:

    * **Document**–returns a single table representing a row for each top-level object.
    * **FlattenedDocuments**–returns a single table representing a JOIN of the available documents in the file.
    * **Relational**–returns multiple tables, one for each **JSON Path** value specified.
  </Step>

  <Step>
    (Optional) Enter the **JSON Path**, which is the JSONPath expression that defines which array elements are modeled as rows. For multiple paths, provide a semicolon-separated list. If left blank, object arrays in the JSON document are detected automatically and modeled as rows.
  </Step>

  <Step>
    (Optional) Select the **JSON Format** to use. Options are as follows:

    * **JSON**–the default format to be used in a majority of cases.
    * **JSONRows**–the data is returned in a relational format consisting of rows of data contained within primitive arrays.
    * **LDJSON (Line-Delimited JSON)**–used to parse line-delimited JSON files (also known as NDJSON or JSONLines).
  </Step>

  <Step>
    Select the **Connection Type**, which specifies the file storage service, server, or file access protocol through which your JSON files are stored and retrieved. Then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Connection Types

<Tabs>
  <Tab title="Amazon S3">
    <Steps>
      <Step>
        Select the **AWS Region** from the drop-down list. This is the hosting region for your Amazon Web Services.
      </Step>

      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme** to use when connecting to remote services. Then select the tab for your authentication scheme and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AwsRootKeys">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsEC2Roles">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsIAMRoles">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Role ARN**. This is the Amazon Resource Name of the role to use when authenticating.
          </Step>

          <Step>
            (Optional) Enter the **AWS External Id**. This is a unique identifier that might be required when you assume a role in another account.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsTempCredentials">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to AWS. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Session Token**. See the [AWS Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) for more information about the session token.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsCredentialsFile">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Keycloak">
        <Steps>
          <Step>
            Enter the **Keycloak Realm URL**. This specifies the full URL to the Keycloak server, including the specific realm used for authentication and authorization.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="EKSPodIdentity">
        <Steps>
          <Step>
            (Optional) Enter the **AWS Container Credentials Full URI**. This is the full URI of the container credential provider endpoint used by EKS Pod Identity.
          </Step>

          <Step>
            (Optional) Enter the **AWS Container Authorization Token File**. This is the path to a file containing the authorization token for the EKS Pod Identity credential provider.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Blob Storage">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2 SSL">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Files">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Box">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Dropbox">
    <Steps>
      <Step>
        (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTP">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTPS">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Google Cloud Storage">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Google Drive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS Secure">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTP">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTPS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="IBM Object Storage Source">
    <Steps>
      <Step>
        Enter the **Api Key** used to identify the user to the IBM Cloud.
      </Step>

      <Step>
        Enter the **Region**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from the security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneDrive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneLake">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Oracle Cloud Storage">
    <Steps>
      <Step>
        Enter the hosting **Region** for your S3-like Web Services.
      </Step>

      <Step>
        Enter the **Oracle Namespace**. This is the Oracle Cloud Object Storage namespace to use.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SFTP">
    <Steps>
      <Step>
        Select the **SSH Auth Mode**, which is the type of authentication to use when connecting to remote services. Then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Password">
        <Steps>
          <Step>
            Enter the **SSH User** used to authenticate to the SFTP server.
          </Step>

          <Step>
            Enter the **SSH Password** used to authenticate to the SFTP server.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Public_Key">
        <Steps>
          <Step>
            Enter the **SSH Client Cert**, which is the name of the certificate store for the client certificate.
          </Step>

          <Step>
            Select the **SSH Client Cert Type**, which is the type of key store containing the client certificate.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Password**. This is the password for the client certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Subject**. This is the subject of the SSH client certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint SOAP">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST V1">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and JSON, see [this information page](https://cdn.cdata.com/help/DJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Jira Assets
Source: https://docs.cloud.cdata.com/en/Data-Sources/JiraAssets



## Setup Guide

Follow these steps to connect Jira Assets to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Jira Assets* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** to your Jira Assets endpoint, for example, `https://yoursitename.atlassian.net`.
  </Step>

  <Step>
    Enter the Jira Assets username for authentication in the **User** field.
  </Step>

  <Step>
    Enter the Jira **API token** for the username that you entered in the **User** field. To create an API token:

    * Navigate to [the API Tokens page of your Atlassian account](https://id.atlassian.com/manage/api-tokens).
    * Click **Create API token**.
    * Name your API token and adjust the expiration date, if necessary.
    * Click **Create**.
    * Copy and paste the API token.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Jira Service Desk
Source: https://docs.cloud.cdata.com/en/Data-Sources/JiraServiceDesk



## Setup Guide

Follow these steps to connect Jira Service Desk to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Jira Service Desk* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Jira Service Desk username for authentication.
        * **Password**—the user password.
        * **URL**—the URL to your Jira Service Desk endpoint (for example, `https://yoursitename.atlassian.net`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your Jira Service Desk account for OAuth.
        * **OAuth Client Secret**—the client secret assigned when you registered your Jira Service Desk account for OAuth.
        * **URL**—the URL to your Jira Service Desk endpoint (for example, `https://yoursitename.atlassian.net`).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Jira Service Desk sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Jira Service Desk account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIToken">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Jira Service Desk username for authentication.
        * **API Token**—to connect to a Connect AI account, you need to retrieve an API token. To generate one, log in to your Atlassian account and under **Security** settings, click **Create and manage API tokens** and then click **Create API token**.
        * **URL**—the URL to your Jira Service Desk endpoint (for example, `https://yoursitename.atlassian.net`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Crowd">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Jira Service Desk username for authentication.
        * **Password**—the user password.
        * **SSO Login URL**—the login URL associated with the Crowd account. You can find the IDP URL by navigating to **your application** > **SSO** > **SSO information** > **Identity provider single sign-on URL**.
        * **SSO Exchange URL**—the URL used to exchange the SAML token for Jira Service Desk cookies. This URL may have the following formats: `https://<authority of Jira Service Desk instance>/plugins/servlet/samlconsumer` or `https://<authority of Jira Service Desk instance>/plugins/servlet/samlsso`.
        * **SSO App Name**—the name of the application in which SSO is enabled.
        * **SSO App Password**—the password of the application in which SSO is enabled.
        * **URL**—the URL to your Jira Service Desk endpoint (for example, `https://yoursitename.atlassian.net`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Jira Service Desk username for authentication.
        * **Password**—the user password.
        * **SSO Login URL**—the login URL associated with the Okta account. You can find the IDP URL by navigating to **your application** > **SSO** > **SSO information** > **Identity provider single sign-on URL**.
        * **SSO Properties**—enter all relevant properties with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
        * **SSO Exchange URL**—the URL used to exchange the SAML token for Jira Service Desk cookies. This URL may have the following formats: `https://<authority of Jira Service Desk instance>/plugins/servlet/samlconsumer` or `https://<authority of Jira Service Desk instance>/plugins/servlet/samlsso`.
        * **URL**—the URL to your Jira Service Desk endpoint (for example, `https://yoursitename.atlassian.net`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Jira Service Desk, see [this information page](https://cdn.cdata.com/help/GKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Kintone
Source: https://docs.cloud.cdata.com/en/Data-Sources/Kintone



## Setup Guide

Follow these steps to connect Kintone to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Kintone* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the Kintone **URL** (for example, `https://*SubdomainName*.cybozu.com`)
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        In the **User** field, enter the Kintone username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="API Token">
    <Steps>
      <Step>
        In the **App Id** field, enter the application Id to use for authentication.
      </Step>

      <Step>
        In the **API Token** field, add the API token to use for authentication with the application Id. To generate an API token in Kintone, navigate to **App Settings tab > API Token** and click the **Generate** Button.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Kintone, see [this information page](https://cdn.cdata.com/help/EKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Klaviyo
Source: https://docs.cloud.cdata.com/en/Data-Sources/Klaviyo



## Setup Guide

Follow these steps to connect Klaviyo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Klaviyo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    For **Schema**, enter the Klaviyo API Revision the provider uses on a connection. The default value is `Klaviyo20250415`.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="API Key">
    <Steps>
      <Step>
        Enter the **API Key** used for accessing your Klaviyo account. To generate the API Key:

        1. Log in to your user account.
        2. Navigate to the [Private API Key creation page](https://www.klaviyo.com/login?next=/settings/account/api-keys).
        3. Click **Create Private API Key**.
        4. Under **Private API Key Name**, assign a name to the key.
        5. Under **Select Access Level**, choose the required access level. At minimum, **Accounts: Read** access is required for a successful Test Connection.
        6. Click **Create** to generate the API Key. Copy and save the generated API Key, as it is only shown once.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        To authenticate using OAuthPKCE, you must first create a custom OAuth application. Then set the following properties:

        * **OAuthClientId**–enter the client Id (also known as the consumer key) assigned when you registered your app for OAuth.
        * **OAuthClientSecret**–enter the client secret assigned when you registered your app for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Databricks Lakebase
Source: https://docs.cloud.cdata.com/en/Data-Sources/Lakebase



## Prerequisites

To use the OAuthClient authentication method, you must create a service principal in Databricks Lakebase and assign permissions. Refer to the [Databricks documentation](https://docs.databricks.com/aws/en/admin/users-groups/manage-service-principals).

Next, the account or workspace administrator creates an OAuth secret:

<Steps>
  <Step>
    At the new service principal's details page, in the **Developer Service Principal** section, click the **Secrets** tab.
  </Step>

  <Step>
    Under OAuth secrets, click the **Generate secret** button.
  </Step>

  <Step>
    Enter the desired lifetime for the secret in days, up to a maximum of 730 days (two years). The admin console displays updated details about the new service principal, including the OAuth secret and the Client ID (which is the same as the service principal's application ID).
  </Step>

  <Step>
    Enter the Client Id and Secret in the fields below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Databricks Lakebase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Databricks Lakebase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the **Server** name hosting the Databricks Lakebase database.
  </Step>

  <Step>
    Enter the name of the target Databricks Lakebase **Database**.
  </Step>

  <Step>
    For **Databricks Instance**, enter the URL for the user interface during normal access of the Databricks console. This should be in the format of `dbc-(id).cloud.databricks.com`.
  </Step>

  <Step>
    Enter the **Port** number of the server hosting the Databricks Lakebase database. The default value is 5432.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the **OAuthClientId** assigned when you configured the service principal (in the prerequisites).
      </Step>

      <Step>
        Enter the **OAuthClientSecret** assigned when you configured the service principal (in the prerequisites). This value authenticates the application to the OAuth authorization server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Enter the **User** Id of the authenticating user. The user obtains a temporary code from the authorization server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Lakebase, see [this information page](https://cdn.cdata.com/help/LSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# CRM Analytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/TableauCRM



## Setup Guide

Follow these steps to connect CRM Analytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *CRM Analytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the CRM Analytics sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your CRM Analytics account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuthJWT Cert**—the content of the certificate in PEM format.
        * **OAuthJWT Issuer**—the OAuth Client Id of the connected app for which you registered the certificate.
        * **OAuthJWT Cert Password**—(Optional) required if the certificate is encrypted.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and CRM Analytics, see [this information page](https://cdn.cdata.com/help/FSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Klipfolio
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Klipfolio



## Prerequisites

Before you can add the connection, you must generate an API key from the Klipfolio Dashboard app:

<Steps>
  <Step>
    Log in to the Klipfolio Dashboard app and open the **My Profile** page. If you are an administrator with the **user.manage** permission, you can instead generate a key for any user from the **Users** page.
  </Step>

  <Step>
    Generate an **API key**, then copy it and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Klipfolio to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Klipfolio* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Klipfolio account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MailerLite
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-MailerLite



## Prerequisites

Before you can add the connection, you must generate an API key from your MailerLite account:

<Steps>
  <Step>
    Log in to your MailerLite account and navigate to **Integrations** > **Developer API**.
  </Step>

  <Step>
    Click **Generate new token**, enter a name for the token, and click **Create token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect MailerLite to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MailerLite* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your MailerLite account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Mailgun
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Mailgun



## Prerequisites

Before you can add the connection, you must obtain an API key from your Mailgun account:

<Steps>
  <Step>
    Log in to your Mailgun account and open the dropdown next to your account name.
  </Step>

  <Step>
    Go to **Account Settings** > **API Security**.
  </Step>

  <Step>
    Click **Create Key** and copy the generated key.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Mailgun to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Mailgun* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Mailgun account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Mailjet
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Mailjet



## Prerequisites

Before you can add the connection, you must obtain your API Key and Secret from your Mailjet account:

<Steps>
  <Step>
    Log in to your Mailjet account and go to **My Account** > **REST API** > **API Key Management**.
  </Step>

  <Step>
    Locate your **API Key** and **Secret Key** and copy both values.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Mailjet to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Mailjet* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set the **User** to your Mailjet API Key and the **Password** to your Mailjet API Secret.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Mixpanel
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Mixpanel



## Prerequisites

Before you can add the connection, you must create a service account in Mixpanel. You must have Owner or Admin permissions to do this.

<Steps>
  <Step>
    Log in to Mixpanel and go to **Organization Settings** > **Service Accounts**.
  </Step>

  <Step>
    Create a new service account, selecting its role and the projects it can access.
  </Step>

  <Step>
    Copy the generated **Username** and **Secret**. Store them securely. Mixpanel only displays the secret once.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Mixpanel to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Mixpanel* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **User**, which is the service account username from Mixpanel.
  </Step>

  <Step>
    Enter the **Password**, which is the service account secret from Mixpanel.
  </Step>

  <Step>
    Select the **Domain** that corresponds to your data residency region: **mixpanel** (US), **eu.mixpanel** (EU), or **in.mixpanel** (India).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Mode
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Mode



## Prerequisites

Before you can add the connection, you must obtain an API access token and API secret from Mode:

<Steps>
  <Step>
    In Mode, open **Workspace Settings** > **Administration** > **API Tokens**.
  </Step>

  <Step>
    Click **Create Token**.
  </Step>

  <Step>
    Copy the **API Access Token** and **Password (Access Secret)**. Store both values securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Mode to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Mode* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **User**, which is your Mode API Access Token.
  </Step>

  <Step>
    Enter the **Password**, which is your Mode Password (Access Secret).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Moosend
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Moosend



## Prerequisites

To authenticate to Moosend, you must obtain an API key from your account settings:

<Steps>
  <Step>
    Log in to your Moosend account and click **More** > **Settings** in the top menu bar.
  </Step>

  <Step>
    Select **API key** from the left-hand menu and copy your API key.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Moosend to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Moosend* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Moosend account settings.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Notion
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Notion



## Setup Guide

Follow these steps to connect Notion to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Notion* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    To use OAuth authentication, you need to create a public integration with Notion to obtain a client ID and client secret:

    <Steps>
      <Step>
        Go to [Notion integrations](https://www.notion.so/my-integrations) and click **New integration**.
      </Step>

      <Step>
        Select **Public integration** to enable OAuth.
      </Step>

      <Step>
        Configure your integration with a name and workspace.
      </Step>

      <Step>
        Navigate to the **OAuth Domain & URIs** section and add the Connect AI callback URL as your redirect URI: *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        In the **Secrets** section, copy the **OAuth client ID** and **OAuth client secret**. In Connect AI, these are entered as the **OAuth Client Id** and **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Notion.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Notion sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Notion account and select the pages the integration can access.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIKey">
    To use API Key authentication, create an internal integration in Notion and copy its integration token:

    <Steps>
      <Step>
        Go to [Notion integrations](https://www.notion.so/my-integrations) and click **New integration**.
      </Step>

      <Step>
        Give the integration a name, associate it with the workspace you want to access, and keep the integration type as **Internal**.
      </Step>

      <Step>
        Create the integration, then copy the **Internal Integration Secret** (the integration token) and store it securely.
      </Step>

      <Step>
        In the **More** menu, share your Notion pages and databases with this integration to grant it access.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **API Key**, which is the Notion integration token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Omnisend
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Omnisend



## Prerequisites

Before you can add the connection, you must find your API key in your Omnisend account:

<Steps>
  <Step>
    Log in to your Omnisend account and go to [https://app.omnisend.com/#/my-account/integrations/api-keys](https://app.omnisend.com/#/my-account/integrations/api-keys).
  </Step>

  <Step>
    Copy your **API key** and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Omnisend to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Omnisend* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your Omnisend account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Optimizely
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Optimizely



## Prerequisites

Before you can add the connection, you must register an OAuth application with Optimizely:

<Steps>
  <Step>
    Log in to your Optimizely account and go to [https://app.optimizely.com/accountsettings/apps/developers](https://app.optimizely.com/accountsettings/apps/developers).
  </Step>

  <Step>
    Register a new application. Optimizely assigns your app an **OAuth Client ID** and **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Optimizely to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Optimizely* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Optimizely.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Optimizely sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Optimizely account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PagerDuty
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-PagerDuty



## Prerequisites

Before you can add the connection, you must register an OAuth application in PagerDuty:

<Steps>
  <Step>
    Log in to your PagerDuty account and click the app icon to the left of your profile picture.
  </Step>

  <Step>
    Select **Developer Mode** to open the **My Apps** page.
  </Step>

  <Step>
    Click **Create New App**.
  </Step>

  <Step>
    Enter a name and description for the application.
  </Step>

  <Step>
    Set the **Redirect URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save the application, then copy the **Client ID** and **Client Secret**. Store the secret securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect PagerDuty to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PagerDuty* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from PagerDuty.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the PagerDuty sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your PagerDuty account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Paymo
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Paymo



## Prerequisites

Before you can add the connection, you must generate an API key from your Paymo account:

<Steps>
  <Step>
    Log in to your Paymo account and navigate to **My Settings**.
  </Step>

  <Step>
    Under **Integrations**, select **API Keys**.
  </Step>

  <Step>
    Click **Generate New Key** and copy the key. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Paymo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Paymo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Perplexity
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Perplexity



## Prerequisites

Before you can add the connection, you must generate an API key from your Perplexity account:

<Steps>
  <Step>
    Go to the [Perplexity API dashboard](https://www.perplexity.ai/settings/api) and generate a new key.
  </Step>

  <Step>
    Copy the key and store it securely.
  </Step>
</Steps>

The API key provides access to asynchronous chat completion jobs and results.

## Setup Guide

Follow these steps to connect Perplexity to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Perplexity* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your Perplexity account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Polar Team Pro
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-PolarTeamPro



## Prerequisites

Before you can add the connection, you must register an OAuth application with Polar Team Pro:

<Steps>
  <Step>
    Navigate to the [Polar AccessLink admin portal](https://admin.polaraccesslink.com/) and log in.
  </Step>

  <Step>
    Click **Create New Application**.
  </Step>

  <Step>
    Enter an application name and set the **Redirect URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Register**. The portal displays your **Client ID** and **Client Secret**. Store these values securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Polar Team Pro to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Polar Team Pro* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the Polar AccessLink admin portal.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Polar Team Pro sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Polar Team Pro account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Printful
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Printful



## Prerequisites

Before you can add the connection, you must generate an API key from your Printful store:

<Steps>
  <Step>
    Log in to your Printful account and navigate to **Settings** > **Stores**.
  </Step>

  <Step>
    Select the store you want to connect.
  </Step>

  <Step>
    Click **Add API Access** to generate an API key, then copy it and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Printful to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Printful* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your Printful store settings.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Printify
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Printify



## Prerequisites

Before you can add the connection, you must generate a Personal Access Token from your Printify account:

<Steps>
  <Step>
    Log in to your Printify account and navigate to **My Profile**, then **Connections**.
  </Step>

  <Step>
    In the **Connections** section, set your **Token Access Scopes**, then generate your Personal Access Token. Copy the token. Store it securely. Tokens are valid for one year and can be re-generated after expiration.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Printify to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Printify* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Procore
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Procore



## Setup Guide

Follow these steps to connect Procore to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Procore* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    Use this method to authenticate as an individual user through an interactive browser sign-in. First register an OAuth application in the Procore Developer Portal:

    <Steps>
      <Step>
        Sign in to the [Procore Developer Portal](https://developers.procore.com/) and open **My Apps**.
      </Step>

      <Step>
        Click **Create New App**, enter an app name, and create the app.
      </Step>

      <Step>
        Create a new version of the **Sandbox** manifest and add an **OAuth** (authorization code) component.
      </Step>

      <Step>
        Set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Promote the manifest to **Production** to obtain your production credentials.
      </Step>

      <Step>
        On the app page, make note of the **Client ID** and **Client Secret**. In Connect AI, the Client ID is entered as the **OAuth Client Id** and the Client Secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Procore.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Procore sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Procore account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    Use this method for a service-to-service connection that authenticates with the OAuth client credentials grant, without an interactive browser sign-in. First register a service account application in the Procore Developer Portal:

    <Steps>
      <Step>
        Sign in to the [Procore Developer Portal](https://developers.procore.com/) and open **My Apps**.
      </Step>

      <Step>
        Click **Create New App**, enter an app name, and create the app.
      </Step>

      <Step>
        Create a new version of the **Sandbox** manifest and add a **Data Connection** (service account) component, which uses the client credentials grant.
      </Step>

      <Step>
        Promote the manifest to **Production** to obtain your production credentials.
      </Step>

      <Step>
        On the app page, make note of the **Client ID** and **Client Secret**. In Connect AI, the Client ID is entered as the **OAuth Client Id** and the Client Secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Procore.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Sage HR
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-SageHR



## Prerequisites

Before you can add the connection, you must obtain an API key from your Sage HR account:

<Steps>
  <Step>
    Click your name in the top-right corner, then click **Settings**.
  </Step>

  <Step>
    In the settings menu, click **INTEGRATIONS**, then click **API**.
  </Step>

  <Step>
    Click **ENABLE API ACCESS** to activate API access and generate your unique API key.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Sage HR to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Sage HR* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Subdomain**. This is the subdomain of your Sage HR account URL (for example, if your account URL is mycompany.sage.hr, enter *mycompany*).
  </Step>

  <Step>
    Enter the **API Key** generated from your Sage HR account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Samanage
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Samanage



## Prerequisites

Before you can add the connection, you must generate a JSON web token from your Samanage account:

<Steps>
  <Step>
    Log in to your Samanage account and navigate to **Setup** > **Users**.
  </Step>

  <Step>
    Click your username to open your **User Detail** page.
  </Step>

  <Step>
    In the **Action** drop-down menu, select **Generate JSON Web Token** and copy the token.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Samanage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Samanage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** (JSON web token) generated in the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft Entra ID
Source: https://docs.cloud.cdata.com/en/Data-Sources/AzureAD



## Setup Guide

Follow these steps to connect Microsoft Entra ID to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft Entra ID* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Microsoft Entra ID sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Microsoft Entra ID account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** that you use to access data.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter your **OAuth Client Id** assigned when you registered your Microsoft Entra ID account.
      </Step>

      <Step>
        Enter your **OAuth Client Secret** assigned when you registered your Microsoft Entra ID account for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **Azure Tenant** that you use to access data.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter your **OAuth Client Id** assigned when you registered your Microsoft Entra ID account.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert**, the contents of the JWT certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert Password** (optional) if the certificate store requires it.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert Subject** (optional). This is the subject of the OAuth JWT certificate. If omitted, the first certificate in the certificate store is used.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft Entra ID, see [this information page](https://cdn.cdata.com/help/CJJ/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# LDAP
Source: https://docs.cloud.cdata.com/en/Data-Sources/LDAP



## Setup Guide

Follow these steps to connect LDAP to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *LDAP* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **Server** field, enter the domain name or IP address of the LDAP server. Do not include the LDAP:// prefix; only include the server's domain name or IP address.
  </Step>

  <Step>
    Enter the **Port** on which the LDAP server is running. The default port is 389.
  </Step>

  <Step>
    In the **User** field, enter the distinguished name (DN) of the user account used for authentication with the LDAP server.
  </Step>

  <Step>
    Enter the **Password** associated with the distinguished name.
  </Step>

  <Step>
    Enter the **Base DN**. Specifying a base distinguished name limits the scope of searches and can increase performance, especially on large LDAP servers.
  </Step>

  <Step>
    (Optional) Set **Schema** to choose the version to connect with. The default is **Static**, which uses the hard-coded column values in the .rsd files. Set it to **Dynamic** to use the table and column information provided by Active Directory.
  </Step>

  <Step>
    (Optional) Enable **Use SSL** to secure the connection to the LDAP server with SSL encryption.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and LDAP, see [this information page](https://cdn.cdata.com/help/RJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Linear
Source: https://docs.cloud.cdata.com/en/Data-Sources/Linear



## Setup Guide

Follow these steps to connect Linear to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Linear* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="APIKey">
    To use API key authentication, generate a personal API key in Linear:

    <Steps>
      <Step>
        Log in to your Linear account and go to **Settings** > **API** > **Personal API keys**.
      </Step>

      <Step>
        Click **Create key**.
      </Step>

      <Step>
        Enter a descriptive label for the key and click **Create**.
      </Step>

      <Step>
        Copy the generated key immediately and store it securely; it is only displayed once.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the key as the **API Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    To use OAuth authentication, register an OAuth application with Linear:

    <Steps>
      <Step>
        Log in to your Linear account and go to **Settings** > **API** > **OAuth Applications**.
      </Step>

      <Step>
        Click **New OAuth Application**.
      </Step>

      <Step>
        Enter a **Name** for the application.
      </Step>

      <Step>
        Set the **Callback URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Click **Create application**, then copy the **Client ID** and **Client Secret**. Store the secret securely.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Linear.
      </Step>

      <Step>
        Optionally, update the **Scope** field. The default value is `read,write`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Linear sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Linear account and grant the requested permissions.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    OAuthClient uses client credentials for machine-to-machine access without a user sign-in. Register an OAuth application with Linear:

    <Steps>
      <Step>
        Log in to your Linear account and go to **Settings** > **API** > **OAuth Applications**.
      </Step>

      <Step>
        Click **New OAuth Application**.
      </Step>

      <Step>
        Enter a **Name** for the application.
      </Step>

      <Step>
        Set the **Callback URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Click **Create application**, then copy the **Client ID** and **Client Secret**. Store the secret securely.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Linear.
      </Step>

      <Step>
        Optionally, update the **Scope** field. The default value is `read,write`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# LinkedIn
Source: https://docs.cloud.cdata.com/en/Data-Sources/LinkedIn



## Setup Guide

Follow these steps to connect LinkedIn to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *LinkedIn* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) Enter your **Company Id**. This is the number that appears in the URL; for example, in the URL `www.linkedin.com/company/1337`, 1337 is the Company Id.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the LinkedIn sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your LinkedIn account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and LinkedIn, see [this information page](https://cdn.cdata.com/help/CLM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# LinkedIn Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/LinkedInAds



## Setup Guide

Follow these steps to connect LinkedIn Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *LinkedIn Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the LinkedIn Ads sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your LinkedIn Ads account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and LinkedIn Ads, see [this information page](https://cdn.cdata.com/help/EBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MoneyForward Expense
Source: https://docs.cloud.cdata.com/en/Data-Sources/MFExpense



## Prerequisites

Before you can connect to Connect AI, you must create OAuth client credentials in MoneyForward Expense.

Follow these steps:

<Steps>
  <Step>
    Log in to your MoneyForward Expense account.
  </Step>

  <Step>
    In the **For Developers** section, click **API Linkage**.
  </Step>

  <Step>
    Click **Create Application**.
  </Step>

  <Step>
    Set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Set **Scopes** to *office\_setting:write user\_setting:write transaction:write report:write account:write public\_resource:read*.
  </Step>

  <Step>
    Save your changes. You will use the values for **OAuth Client Id** and **OAuth Client Secret** for your connection.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect MoneyForward Expense to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MoneyForward Expense* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Connect AI, enter the following connection information:

    * **OAuth Client Id**—the client Id generated in the prerequisites.
    * **OAuth Client Secret**—the client secret generated in the prerequisites.
    * **Office Id**—the Id of the office. This is required for most queries.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the MoneyForward Expense sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your MoneyForward Expense account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MoneyForward Expense, see [this information page](https://cdn.cdata.com/help/EYM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft Teams
Source: https://docs.cloud.cdata.com/en/Data-Sources/MSTeams



## Setup Guide

Follow these steps to connect Microsoft Teams to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft Teams* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Microsoft Teams sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Microsoft Teams account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft Teams account.
        * **OAuth Client Secret**—the client secret for your Microsoft Teams account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft Teams account.
        * **OAuth JWL Cert**—the contents of the JWT certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft Teams, see [this information page](https://cdn.cdata.com/help/GSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MYOB
Source: https://docs.cloud.cdata.com/en/Data-Sources/MYOB



## Setup Guide

Follow these steps to connect MYOB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MYOB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select your **Instance**.
  </Step>

  <Step>
    In **User**, enter the MYOB username for authentication.
  </Step>

  <Step>
    Enter the user password into the **Password** field.
  </Step>

  <Step>
    Enter the **Company File Id**. If not specified, the ID of the first returned company file is used.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the MYOB sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your MYOB account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MYOB, see [this information page](https://cdn.cdata.com/help/UMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MailChimp
Source: https://docs.cloud.cdata.com/en/Data-Sources/MailChimp



## Setup Guide

Follow these steps to connect MailChimp to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MailChimp* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Log in to your MailChimp account from a separate browser window.
  </Step>

  <Step>
    Select **Account** > **Extras** > **API Keys**. Copy the API key value.
  </Step>

  <Step>
    Return to Connect AI.
  </Step>

  <Step>
    Enter the API key value from MailChimp in the **API Key** field.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MailChimp, see [this information page](https://cdn.cdata.com/help/CMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MariaDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/MariaDB



## Prerequisites

#### Whitelist CData IPs

To establish a connection to MariaDB, you need to allow access to MariaDB via CData’s IP. When hosting MariaDB behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure MariaDB Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect MariaDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MariaDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the MariaDB server in the **Server** field.
  </Step>

  <Step>
    Enter the port for connecting to the MariaDB server in the **Port** field. This is `3306` by default.
  </Step>

  <Step>
    In the **User** field, enter the MariaDB username for authentication.
  </Step>

  <Step>
    Enter the user password in the **Password** field.
  </Step>

  <Step>
    (Optional) Enter the name of the MariaDB **Database**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MariaDB, see [this information page](https://cdn.cdata.com/help/SRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MarkLogic
Source: https://docs.cloud.cdata.com/en/Data-Sources/MarkLogic



## Setup Guide

Follow these steps to connect MarkLogic to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MarkLogic* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **User**, which specifies the authenticating user's ID.
  </Step>

  <Step>
    Enter the **Password**, which specifies the authenticating user's password.
  </Step>

  <Step>
    Enter the **Server**, which is the address of the MarkLogic server to which you are connecting.
  </Step>

  <Step>
    (Optional) Enter the **Port**, which is the ODBC server port for MarkLogic.
  </Step>

  <Step>
    (Optional) Enter the **Database**, which is the name of the MarkLogic database to connect to.
  </Step>

  <Step>
    (Optional) Select the **API** which the provider uses to query data. The available options are **ODBC** (connect to the ODBC server) and **REST** (connect to the REST API). The default is **ODBC**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MarkLogic, see [this information page](https://cdn.cdata.com/help/OMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Marketo
Source: https://docs.cloud.cdata.com/en/Data-Sources/Marketo



## Prerequisites

Before obtaining OAuth credentials, you need to create a custom service in Marketo if you do not already have one. This procedure involves creating a new role with REST API privileges, assigning that role to an existing or new user, and then creating a new service.

Note that only users with Admin privileges can create a Custom Service and that the term “service” refers to the entity created to provide OAuth credentials for API access.

**Step 1: Create a New Role for API Access**

<Steps>
  <Step>
    Navigate to the Marketo application's **Admin** area.
  </Step>

  <Step>
    Navigate to the **Security** section.
  </Step>

  <Step>
    Click **Users & Roles**.
  </Step>

  <Step>
    Select the **Roles** tab.
  </Step>

  <Step>
    Click **New Role**.
  </Step>

  <Step>
    Specify a Role Name and select Role permissions. Specify Access API permissions that are specific to the REST API.
  </Step>
</Steps>

**Step 2: Assign or Create a New User for API Access**

<Steps>
  <Step>
    Select the **Users** tab.
  </Step>

  <Step>
    To assign the role to a user, click **Invite New User**.
  </Step>

  <Step>
    Enter the new user information and assign them the role you just created with REST API access.
  </Step>

  <Step>
    To denote the user as an API Only user, select the **API Only** option.
  </Step>
</Steps>

**Step 3: Create the New Service**

<Steps>
  <Step>
    Navigate to **Admin** > **Integration** and click the **LaunchPoint** option.
  </Step>

  <Step>
    Click **New Service**.
  </Step>

  <Step>
    Specify the Service Type as **Custom**.
  </Step>

  <Step>
    Enter a display name and description for the service.
  </Step>

  <Step>
    Assign the user you just created to the service.
  </Step>
</Steps>

Once you have a custom service, do the following:

<Steps>
  <Step>
    Go to the **Admin** tab.
  </Step>

  <Step>
    Click the **LaunchPoint** option.
  </Step>

  <Step>
    Select the custom service and click **View Details**. Marketo displays a window that shows the authentication credentials.
  </Step>

  <Step>
    Copy and paste the Client Id as the **OAuthClientId** and the Client Secret as the **OAuthClientSecret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Marketo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Marketo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Marketo **URL**. You can locate this in **Admin** > **Integration** > **Web Services** > **REST API**. Example values: *[https://123-abc-456.mktorest.com/](https://123-abc-456.mktorest.com/)* or *[https://123-abc-456.mktorest.com/rest](https://123-abc-456.mktorest.com/rest)*.
  </Step>

  <Step>
    Paste the **OAuth Client Id** you obtained in the prerequisites.
  </Step>

  <Step>
    Paste **OAuth Client Secret** you obtained in the prerequisites.
  </Step>

  <Step>
    (Optional) Set **Use Bulk API** to True to let it handle bulk requests of certain large datasets.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Marketo, see [this information page](https://cdn.cdata.com/help/DKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft Planner
Source: https://docs.cloud.cdata.com/en/Data-Sources/MicrosoftPlanner



## Setup Guide

Follow these steps to connect Microsoft Planner to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft Planner* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Microsoft Planner sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Microsoft Planner account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft Planner account.
        * **OAuth Client Secret**—the client secret for your Microsoft Planner account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft Planner account.
        * **OAuth JWL Cert**—the contents of the JWT certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft Planner, see [this information page](https://cdn.cdata.com/help/UIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft Project
Source: https://docs.cloud.cdata.com/en/Data-Sources/MicrosoftProject



## Setup Guide

Follow these steps to connect Microsoft Project to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft Project* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** for your Microsoft Project Web App (for example, `https://MyOrganization.sharepoint.com/sites/pwa/`).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="SharePointOnlineCookies">
    <Steps>
      <Step>
        Enter the Microsoft Project username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Microsoft Project account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Microsoft Project account for OAuth.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Microsoft Project username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OneLogin">
    <Steps>
      <Step>
        Enter the Microsoft Project username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id that you will use to access data.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter your **OAuth Client Id**.
      </Step>

      <Step>
        Enter your **OAuth Client Secret**.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft Project, see [this information page](https://cdn.cdata.com/help/COM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Monday.com
Source: https://docs.cloud.cdata.com/en/Data-Sources/Monday



## Setup Guide

Follow these steps to connect Monday.com to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Monday.com* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Schema** then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## AuditLog Schema

<Steps>
  <Step>
    Enter your **Domain**. This follows the format `https://yourdomain.monday.com`.
  </Step>

  <Step>
    Enter the **Api Token** generated in your Monday account under **Manage Application**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## GraphQL Schema

Select the Authentication method, then proceed to the relevant section and follow those instructions.

### Token

<Steps>
  <Step>
    Enter the **Api Token** generated in your Monday account under **Manage Application**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

### OAuth

<Steps>
  <Step>
    Enter the **OAuth Client Id** assigned when you registered your Monday.com account for OAuth.
  </Step>

  <Step>
    Enter the **OAuth Client Secret** for your Monday.com account for OAuth.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Monday.com sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Monday.com account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Monday.com, see [this information page](https://cdn.cdata.com/help/MOJ/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MongoDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/MongoDB



## Prerequisites

#### Whitelist CData IPs

To establish a connection to MongoDB, you need to allow access to MongoDB via CData’s IP. When hosting MongoDB behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure MongoDB Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect MongoDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MongoDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the MongoDB server in the **Server** field.
  </Step>

  <Step>
    Specify the port for connecting to the MongoDB server in the **Port** field. By default this is set to 27017.
  </Step>

  <Step>
    Enter the name of the MongoDB **Database**.
  </Step>

  <Step>
    Select the **Auth Scheme** you use to connect to MongoDB. Options are: `MONGODB-CR`, `SCRAM-SHA-1`, `SCRAM-SHA-256`, and `X509`.
  </Step>

  <Step>
    Enter the MongoDB username for authentication in the **User** field.
  </Step>

  <Step>
    In the **Password** field, enter the user password.
  </Step>

  <Step>
    (Optional) If the authentication database is different from the database to retrieve data from, enter it into the **Auth Database** field.
  </Step>

  <Step>
    In MongoDB, add the Connect AI static IP addresses to your connection whitelist.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

### Connect to Replica Sets

<Steps>
  <Step>
    To connect to a replica set, click on **Advanced Settings**.
  </Step>

  <Step>
    Set **Replica Set** to a list of comma-separated list of secondary servers, specified by address and port.
  </Step>

  <Step>
    Set **Slave OK** to `True`.
  </Step>

  <Step>
    Set **Read Preference** to determine how the provider reads from the secondary servers.

    * `primary` executes all SELECT queries against the primary server.
    * `primaryprefered` executes SELECT queries from a secondary server when the primary is not available.
    * `secondary` executes SELECT queries on secondary servers only.
    * `secondary prefered` executes SELECT queries on the primary server in the event no secondaries are available.
    * `nearest` executes SELECT queries on whichever server has the least latency.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MongoDB, see [this information page](https://cdn.cdata.com/help/DGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MySQL
Source: https://docs.cloud.cdata.com/en/Data-Sources/MySQL



## Prerequisites

#### Whitelist CData IPs

To establish a connection to MySQL, you need to allow access to MySQL via CData’s IP. When hosting MySQL behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure MySQL Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect MySQL to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MySQL* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    If your MySQL connection is behind a firewall, set the **Connection Type** to **SSH Tunnel** and follow the instructions in [SSH Tunnel Instructions](#ssh-tunnel-instructions). Then continue with these instructions. Otherwise, leave the **Connection Type** as **Direct**.
  </Step>

  <Step>
    Enter the following information:

    * **Server**—the host name or IP address of the MySQL server. Cluster servers are supported (for example, `192.168.0.1,192.168.0.2`).
    * **Port**—the port for connecting to the MySQL server.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the MySQL username for authentication.
        * **Password**—the user password.
        * **Database**—(Optional) the name of the MySQL database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the MySQL username for authentication.
        * **Azure Tenant**—the MySQL tenant that you want to use to access data.
        * **Database**—(Optional) the name of the MySQL database.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the MySQL sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your MySQL account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Azure Password">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the MySQL username for authentication.
        * **Password**—the user password.
        * **Azure Tenant**—the MySQL tenant that you want to use to access data.
        * **Database**—(Optional) the name of the MySQL database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## SSH Tunnel Instructions

If your MySQL data source is behind a firewall, follow these instructions.

<Steps>
  <Step>
    Click **Connection Type** of **SSH Tunnel**.
  </Step>

  <Step>
    Enter the following information:

    * **SSH Server**–enter the name of the SSH server.
    * **SSH Port**–enter the SSH port. The default value is 22.
    * **SSH Auth Mode**–enter the authentication mode of **Password** or **Public\_Key**.
      * If **Password**, enter the **SSH User** name and **SSH Password**.
      * If **Public\_Key**, enter the **SSH User** name, **SSH Client Cert**, and **SSH Client Cert Password** (optional). Only PEMKEY\_BLOB is available as the **SSH Client Cert Type**. The **SSH Client Cert** is required, and is a valid private key. Enter the **SSH Client Cert Password** if the SSH client certificate has a password.
  </Step>

  <Step>
    Continue with the authentication instructions in the [Setup Guide](#setup-guide).
  </Step>
</Steps>

## Private Cloud Connector Connection

MySQL is a supported connector with Private Cloud Connector, which acts as a bridge between your on-premises data and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information. Once you set up the gateway, you can select the **Connection Type** of **Private Cloud Connector**. Then enter **Location Name** of the gateway and the MySQL authentication information.

## More Information

For more information about interactions between Connect AI and MySQL, see [this information page](https://cdn.cdata.com/help/DMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Neo4j
Source: https://docs.cloud.cdata.com/en/Data-Sources/Neo4j



## Setup Guide

Follow these steps to connect Neo4j to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Neo4j* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Server** hosting the Neo4j instance. You may optionally prepend a HTTP or HTTPS protocol prefix to the server address or name you specify, for example, [https://127.0.0.1](https://127.0.0.1). The default value is 127.0.0.1.
  </Step>

  <Step>
    Enter the **Port** used for connecting to the Neo4j server. The default value is 7474. If connecting over HTTPS, supply the HTTPS port for the Neo4j instance specified in the **Server** field.
  </Step>

  <Step>
    Enter the **API** to connect to in your Neo4j instance, **Query** or **HTTP**.
  </Step>

  <Step>
    Enter the **User** Id for the authenticating user.
  </Step>

  <Step>
    Enter the **Password** for the authenticating user.
  </Step>

  <Step>
    Enter the **Database** to target in the Neo4j instance. The default value is Neo4j.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Neo4j, see [this information page](https://cdn.cdata.com/help/LNK/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# NetSuite
Source: https://docs.cloud.cdata.com/en/Data-Sources/NetSuite

NetSuite supports two connection methods: SuiteQL and SuiteTalk. Each method has benefits and drawbacks, as outlined below. For most users, CData recommends using SuiteQL.

For a detailed discussion about the differences between SuiteTalk and SuiteQL, see the [NetSuite driver documentation](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_suiteql).

### SuiteQL

SuiteQL is the newer of the two connection methods. This method offers much better performance, especially when you issue large queries. It also supports rich join support, grouping, aggregation, custom list tables, and retrieval of specific columns in your data.

However, SuiteQL only supports SELECT queries. As a result, you cannot issue INSERT, UPDATE, or DELETE queries to NetSuite when you are connected via SuiteQL.

### SuiteTalk

SuiteTalk is the older of the two connection methods. This method provides broad entity support and full support for INSERT, UPDATE, and DELETE queries. However, it often performs poorly during large SELECT queries and lacks reliable table joining capabilities. You also cannot group or aggregate data using SuiteTalk.

For performance and reliability reasons, CData recommends using SuiteTalk only if you require access to INSERT, UPDATE, and DELETE queries for your connection to NetSuite.

## Setup Guide

To configure your NetSuite connection, follow these steps:

<Steps>
  <Step>
    Configure [user roles](#configure-roles).
  </Step>

  <Step>
    Choose a connection method (SuiteQL/OAuth or SuiteTalk/Token). Note that NetSuite does not support basic authentication through username and password credentials in recent versions. Connect AI recommends using OAuth or Token authorization.
  </Step>

  <Step>
    Follow the steps under [Connect to NetSuite](#connect-to-netsuite) to establish the connection.
  </Step>
</Steps>

### Configure Roles

Connect AI communicates with NetSuite through NetSuite Web services. If the user account that you will use for establishing the connection does not have NetSuite Web services permissions, follow these steps to create them:

<Steps>
  <Step>
    Log in to NetSuite as an administrator. From the navigation bar, select **Setup** > **Users/Roles** > **Manage Roles**.
  </Step>

  <Step>
    Choose an existing role or create a new one, depending on your needs.
  </Step>

  <Step>
    On the **Edit Role** page, navigate to the **Permissions** section.
  </Step>

  <Step>
    Expand the **Setup ()** field.
  </Step>

  <Step>
    In a blank slot, select **SOAP Web Services** and click **Add** to add the permission.
  </Step>

  <Step>
    In another blank slot, select **REST Web Services** and click **Add** to add the permission.
  </Step>

  <Step>
    Add additional permissions.

    * If you plan to connect to NetSuite via SuiteQL/OAuth, add the **OAuth 2.0 Authorized Applications Management** permission.
    * If you plan to connect to NetSuite via SuiteTalk/Token add the **User Access Token** and **Access Token Management** permissions.
      **Important: See [Permission Configurations](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_permissions) in the NetSuite driver documentation for additional permissions that may be needed.**
  </Step>

  <Step>
    When you finish, return to the top of the page and click **Save** to save the role.
  </Step>
</Steps>

Next, add this role to an employee:

<Steps>
  <Step>
    From the navigation bar, select **Lists** > **Employees** > **Employees**. Select an employee or add a new one.
  </Step>

  <Step>
    Scroll to the **Access** section. In the **Roles** subsection, add the role that you created.
  </Step>

  <Step>
    Scroll to the top and click **Save**.
  </Step>
</Steps>

Continue to Connecting to NetSuite below.

### Connect to NetSuite

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *NetSuite* in the **Add Connection** dialog that opens. Click the data-source name when it is displayed.
  </Step>

  <Step>
    On a separate browser tab, log in to your NetSuite account as an administrator role.
  </Step>

  <Step>
    From the top navigation bar, select **Setup** > **Company** > **Company Information**.
  </Step>

  <Step>
    Copy the value for **Account Id** to your clipboard.
  </Step>

  <Step>
    Return to Connect AI and enter the copied value into the **Account Id** field .
  </Step>

  <Step>
    For the **Schema** field, select either SuiteQL or SuiteTalk.
    **Note:** CData recommends SuiteQL for most use cases. Click [here](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_suiteql) for information on the differences between SuiteQL and SuiteTalk.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions. Note that OAuth is only available if SuiteQL is selected, and Basic is only available when Suitetalk is selected.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the NetSuite sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your NetSuite account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        In NetSuite, navigate to **Setup** > **Company** > **Enable Features**.
      </Step>

      <Step>
        Open the **SuiteCloud** tab and scroll to **Manage Authentication**. Make sure the checkbox **Token-Based Authentication** is selected, then scroll to the top and click **Save**.
      </Step>

      <Step>
        Navigate to **Setup** > **Integration** > **Manage Integrations**.
      </Step>

      <Step>
        Create a new integration. Under **Token-based Authentication**, select the **Token-Based Authentication** and **TBA: Authorization Flow** checkboxes.
      </Step>

      <Step>
        In the **Callback URL** field, enter `https://oauth.cdata.com/oauth/`.
      </Step>

      <Step>
        In the **OAuth 2.0** section, if you do not plan to use OAuth elsewhere with this integration, clear the **Authorization Code Grant** checkbox.
      </Step>

      <Step>
        Copy the values for **Consumer Key / Client ID** and **Consumer Secret / Client Secret** from the **Client Credentials** section. You need these values later. (**Note:** If you click **Save** before you copy the consumer key and secret, click **Edit** then **Reset Credentials**.)
      </Step>

      <Step>
        Click **Save** to save the integration.
      </Step>
    </Steps>

    Next, create an access token by following these steps:

    <Steps>
      <Step>
        From the navigation bar, select **Setup** > **Users/Roles** > **Access Tokens**.
      </Step>

      <Step>
        Create a new access token. For the application name, select the integration you created.
      </Step>

      <Step>
        In the **User** and **Role** fields, use the same user and role from the [Configure Roles](#configure-roles) section.
      </Step>

      <Step>
        Click **Save**. Copy the credentials for **Token ID** and **Token Secret**.
      </Step>

      <Step>
        Return to Connect AI and enter your **OAuth Client Id**.
      </Step>

      <Step>
        Enter your Client or Consumer secret into **OAuth Client Secret**.
      </Step>

      <Step>
        Enter your **OAuth Access Token** Id.
      </Step>

      <Step>
        Enter your **OAuth Access Token Secret**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **JWT Scope**–the level of access the token provides to NetSuite data. Valid values include *restlets*, *rest\_webservices*, and *suite\_analytics*. You can specify multiple scopes by separating them with commas.
        * **OAuth JWT Encryption**–select from the drop-down list. This is the encryption algorithm to be used in JWT authentication.
        * **OAuth JWT Headers**–a collection of extra headers to include in the JWT. Each header is a name=value pair. Each pair is separated by a comma.
        * **OAuth JWT Cert**–the contents of the client certificate's JWT certificate store.
        * **OAuth JWT Cert Type**–the type of key store containing the JWT certificate.
        * **OAuth JWT Issuer**–the issuer of the Java Web Token. This is typically either the client Id or email address of the OAuth application.
        * **OAuth JWT Validity Time**–(optional) the length of time the JWT should remain valid, in seconds. The default value is 3600 seconds.
        * **OAuth JWT Cert Password**–(optional) the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave blank.
        * **OAuth JWT Cert Subject**–(optional) the subject of the OAuth JWT certificate used to locate a matching certificate in the store. The wildcard '\*' selects the first certificate.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Note>
      This version is only supported on older versions of NetSuite and is not recommended.
    </Note>

    <Steps>
      <Step>
        In the **User** field, enter the NetSuite username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and NetSuite, see [this information page](https://cdn.cdata.com/help/DNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# NetSuite Custom Reports
Source: https://docs.cloud.cdata.com/en/Data-Sources/NetSuiteRESTlet

NetSuite users who connect with SuiteTalk can use RESTlets or saved searches to create custom reports in Connect AI.

<Note>
  **Note:** RESTlets and saved searches are not compatible with SuiteQL.
</Note>

## RESTlets

This section shows how to use a RESTlet script to query saved searches.

<Note>
  **Note:** Using RESTlets is the recommended way to query saved searches. Using RESTlets is different from the method described in [Saved Searches](#saved-searches). This older method relies on the SuiteTalk API, which is more limited in what saved searches can return.
</Note>

### Create a RESTlet Script

Open a new file in a text editor. Then copy and paste the following RESTlet script and save it as `search_script.js`:

```bash expandable theme={null}
/**
 *@NApiVersion 2.x
 *@NScriptType Restlet
 */
define(['N/search'],
    function (search) {
        // Get a standard NetSuite record
        function _get(context) {
            var myTransactionSearch = search.load({
                id: context.searchid
            });
            var pagedData = myTransactionSearch.runPaged({
                pageSize: 1000
            });
            if (pagedData.count == 0) {
                return JSON.stringify({
                    "pagedData": {
                        "searchDefinition": {
                            "count": [
                                {"columnCount":0}
                            ]
                        }
                    }
                });
            }
            var results = pagedData.fetch({
                index: context.index
            })
            return JSON.stringify(results);
        }

        return {
            get: _get
        };
    });
```

### Using RESTlets to Query Saved Searches

Follow the steps below to deploy the RESTlet script and execute the RESTlet.

#### Enable SuiteScript

Go to **Setup** > **Company** > **Enable Features**. Under the **SuiteCloud** tab, ensure the options for **Client SuiteScript**, **Server SuiteScript**, and **SuiteScript Server Pages** are all enabled.

#### Upload the SuiteScript File

Go to **Documents** > **Files** > **SuiteScripts**. Click the **Add File** button. Upload the `search_script.js` script that you created in [Create a RESTlet Script](#create-a-restlet-script).

#### Create a Script Record

Go to **Customization** > **Scripting** > **Scripts** > **New**. From the menu, find `search_script.js` and select it. Then click **Create Script Record**.

#### Deploy the Script Record

Give the script a name and under the **Deployments** tab add a title. Then click **Save**. This creates a deployment.

<Note>
  **Note:** While the status of the Script Deployment is **Testing**, only the user that created the deployment returns results from any saved searches queried. To make the RESTlet available for other users, update the Status of the Script Deployment to **Released** and add supported roles in the **Audience** tab.
</Note>

#### Get the Deployment / Script Id

You can find a link to the deployment in the Script Record. Follow the link to the deployment. Or, you can also go to **Customization** > **Scripting** > **Script Deployments** and use the filters to find the deployment you made. In the deployment record, you can see a URL and External URL. Copy the script number and deployment number from this URL.

#### Get a Saved Search Id

To execute `search_script.js`, you need to pass it the Id of a saved search: Go to **Lists** > **Search** > **Saved Searches** and copy in the Id of a saved search. We recommend you use a search that is ordered by a column that always gives the same ordering, such as the Date Created. This is because NetSuite does not cache results that can cause duplicates or missing data if data is changed while you are paging through the results.

#### Add a Custom Report

<Steps>
  <Step>
    In the **Sources** page of Connect AI, select your NetSuite connection.
    If you do not yet have a NetSuite connection, follow the steps in the NetSuite [Setup Guide](/en/Data-Sources/NetSuite#setup-guide).
  </Step>

  <Step>
    Click the **Custom Reports** tab and click **Add** to add a new report.
    An **Add Custom Report** dialog appears.
  </Step>

  <Step>
    Select **RestletSchema** and click **Confirm**.
  </Step>

  <Step>
    Enter the following information:

    * **Name**—the name of the custom report.
    * **SearchId**—the Id of the saved search obtained in the NetSuite UI.
    * **ScriptID**—the Script Id of the RESTlet to create a schema for.
    * **DeploymentNum**—the deployment number of the RESTlet schema to execute. Typically, this number is 1.
  </Step>

  <Step>
    Select whether to **UseLabels**. This determines if the NetSuite connector should try to match column names to what would appear in the Saved Search results or just use the API name returned by the saved search itself. Note that even when UseLabels is set to true, names are converted to alphanumeric with underscores. Also, be aware that sometimes labels come back with identical names for saved searches. In these cases, a number is appended to the duplicate names to keep the names unique.
  </Step>

  <Step>
    Select whether to **FlattenSelects**. Set this parameter to false if your saved search includes multiselect columns. This parameter controls how the NetSuite connector models the data types of selects (such as an entity / customer reference). When FlattenSelects is set to false, multiselect data is returned as a JSON aggregate.
    By default, the NetSuite connector exposes two columns for selects – one for the name and one for the value (often an Id). This does not work correctly if your saved search includes multiselect columns. There is nothing in the RESTlet metadata that distinguishes multiselect from single-select columns.
  </Step>

  <Step>
    Click **Save** to save the custom report.
  </Step>
</Steps>

### Limitations

* Currently, the NetSuite connector only supports RESTlets that conform to a response in the format of the included `search_script.js` script.
* The NetSuite connector does not support server side filtering on the results. To enable queries to execute faster, define all filters within the saved search itself.

## Saved Searches

Saved searches are supported with some limitations due to NetSuite restrictions.

<Note>
  **Note:** We recommend taking a look at RESTlets instead of following this guide. While these steps still work, saved searches used from SuiteTalk API as detailed below are limited both in how metadata can be obtained and content available. RESTlets have fewer limitations and return accurate metadata from NetSuite.
</Note>

### SavedSearches View

The SavedSearches view is a good way to retrieve a list of your available saved searches for a given search type. A SearchType must be specified to retrieve information from the SavedSearches view. For instance:

`SELECT * FROM SavedSearches WHERE SearchType='Transaction'`

### Add a Custom Report

<Steps>
  <Step>
    In the **Sources** page of Connect AI, select your NetSuite connection.
  </Step>

  <Step>
    Click the **Custom Reports** tab and click **Add** to add a new report.
    An **Add Custom Report** dialog appears.
  </Step>

  <Step>
    Select **SavedSearchSchema** and click **Confirm**.
  </Step>

  <Step>
    Enter the following information:

    * **Name**—the name of the custom report.
    * **SavedSearch**—the name of the saved search. This becomes the name of the resulting table.
    * **SavedSearchId**—the Id of the saved search.
    * **SearchType**—the type of search for the custom report. Click for a list of search types.
    * **ResultsToSample**—(optional) an integer designating the number of results to sample.
  </Step>

  <Step>
    Click **Save** to save the custom report.
  </Step>
</Steps>

### Limitations

NetSuite imposes a few limitations on saved searches. Calculated columns (formulas) cannot be retrieved via the NetSuite API. Only columns directly from the table can be retrieved. If you have a calculation in your saved search, you would need to return each individual column used in the calculation and perform the calculation client side. Ie:

`SELECT (col1 / col2) AS calc FROM MySavedSearch`

Saved searches that return an aggregation or summary (Group / Count / Sum / Minimum / Maximum / Average) cannot be returned at all. The NetSuite API throws an exception upon attempting to retrieve these saved searches. Due to this limitation, these saved searches are unavailable for our and any other third party tool.

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# NetSuite SuiteAnalytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/NetSuiteSuiteAnalytics



## Setup Guide

Follow these steps to connect NetSuite SuiteAnalytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *NetSuite SuiteAnalytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Server**—the host name or IP address of the server.
    * **AccountId**—the company account your username is associated with on NetSuite.
    * **RoleId**—the InternalId of the role that is used to log in to NetSuite. Obtain the RoleId by logging in to NetSuite and navigating to **Setup** > **Integration** > **Web Services Preferences**. The RoleId is displayed next to the specified role.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the NetSuite SuiteAnalytics username for authentication
        * **Password**—the user password
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the following information:

        * **Consumer Key**—The consumer key for the integration record. This string was created when you created the integration record.
        * **Consumer Secret**—The consumer secret for the integration record. This string was created when you created the integration record.
        * **TokenKey**—The token key used to authenticate requests to the data source.
        * **TokenSecret**—The token secret used to authenticate requests to the data source.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Advanced Settings Tab

### Authentication

Optionally, enter any **Native Driver Properties** in the **Advanced Settings** tab. These are any extra NetSuite SuiteAnalytics properties you want to add to the connection string, along with the other properties from the **Basic Settings** tab.

## Troubleshooting

<Accordion title="Failed to retrieve data">
  If the error contains no further information, and you can reproduce the error, you need to contact NetSuite support.
</Accordion>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# NetSuite Troubleshooting
Source: https://docs.cloud.cdata.com/en/Data-Sources/NetSuiteTroubleshooting

The following are common issues with the NetSuite connection, and suggestions on how to solve them.

## General Troubleshooting

### Performance Considerations

If you find NetSuite to be too slow, you can try the following to improve performance:

* **Limit selected columns**
  <p>NetSuite objects rely heavily on backend JOINs. Removing unused columns can eliminate entire JOINs and significantly improve performance.</p>

* **Reduce page size**
  <p>Lowering the **Pagesize** property returns fewer records per request and can help avoid timeouts before all the results are returned. This property is found in **Edit NetSuite Connection** > **Advanced Settings**. </p>

* **Caching**
  <p>You should also consider using the Connect AI [Caching](/en/Caching) feature for better performance.</p>

### Schema Support and Performance

In general, performance is best in [SuiteAnalytics](/en/Data-Sources/NetSuiteSuiteAnalytics). Connect AI exposes CData's NetSuite driver as well as NetSuite’s native SuiteAnalytics driver as separate connectors. We recommend using the native SuiteAnalytics driver, if your organization has access to it, for best performance. If you do not have access to SuiteAnalytics, use the CData's NetSuite driver.

### Manage Integrations Visibility

To see **Setup** > **Integrations** > **Manage Integrations** in NetSuite, the role must have both of these permissions:

* **Integration Application (Full)** under **Setup**.

* **Integration Applications (Full)** under **Lists**.

See [Permissions Configurations](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_permissions) for more information.

## Common Errors

### SuiteQL Errors

<Accordion title="Unable to retrieve columns for a table (or Invalid search query).">
  This issue is usually a permissions issue to access the object type when using the SuiteQL schema. Note that permissions could apply to either the table or any of the columns in the table. The driver attempts to do a RowScan to determine which fields are available.

  Check your NetSuite role to see if the table is included:

  1. Log in to your NetSuite account as an administrator.
  2. Navigate to **Setup** > **Users/Roles** > **Manage Roles**.
  3. Select the role you are using to connect with the driver.
  4. Click **Edit** > **Permissions**.
  5. Under **Setup**, add **Full** permissions for the table you need.

  View the complete list of permissions required by our driver [here](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_permissions).

  In some cases, the table may have been deprecated or removed by NetSuite. Check whether another table exposes the same data.
</Accordion>

<Accordion title="Column not found">
  * If Connect AI cannot find a column, it may be due to cached or outdated metadata. Clear the metadata cache, if applicable, by clicking **Clear Metadata** on the **Edit NetSuite Connection** page.
  * It is also possible that the **RowScanDepth** property is zero. In that case, increase the **Row Scan Depth** property in the **Advanced Settings** tab of the **Edit NetSuite Connection** page to a non-zero value.
</Accordion>

<Accordion title="Missing rows">
  The SuiteQL schema can only return a maximum of 100,000 records. This limitation is imposed by NetSuite itself. You can bypass this limitation in one of two ways:

  * Set your Schema to SuiteTalk rather than Suite QL.

  * Use the SuiteAnalytics Connect feature. If your account has SuiteAnalytics Connect, enable the SuiteAnalytics Connect feature by setting the **AccountSupportsSuiteAnalyticsConnect** property to True.
</Accordion>

<Accordion title="Custom field not found">
  If you receive this error, you have not set the required **Custom Fields** permissions in NetSuite. See [Permissions Configurations](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_permissions).
</Accordion>

### SuiteTalk Errors

<Accordion title="Missing custom record types permission">
  Adjust the permissions for custom records. See [Permission Configurations](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_permissions).
</Accordion>

<Accordion title="Your role does not support OAuth2 login, please select a different one">
  This error appears when the role that you select during OAuth login is not configured for OAuth. If you have an OAuth-configured role, click **Choose another role** on the NetSuite authorization page and select that role. If you do not have an OAuth-configured role, follow the steps in the [Configure Roles](/en/Data-Sources/NetSuite#configure-roles) section.
</Accordion>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# OData
Source: https://docs.cloud.cdata.com/en/Data-Sources/OData



## Setup Guide

Follow these steps to connect OData to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *OData* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="None">
    **None** is when no authentication is required.

    <Steps>
      <Step>
        Enter the following information:

        * **URL**—the root URL of the OData service (for example, `http://MySite/*MyOrganization*`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    **AzureAD** is a form of OAuth that goes through Azure.

    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant that you use to access data. If you leave this field blank, the account's default tenant is used.
        * **OAuth Client Id**—assigned when you registered your OData account for OAuth.
        * **OAuth Client Secret**—for your OData account for OAuth.
        * **URL**—the root URL of the OData service (for example, `http://MySite/*MyOrganization*`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    **Basic** is basic user name and password authentication.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the user name for the OData service.
        * **Password**—the password for the OData service.
        * **URL**—the root URL of the OData service (for example, `http://MySite/*MyOrganization*`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—assigned when you registered your OData account for OAuth.
        * **OAuthClient Secret**—for your OData account for OAuth.
        * **OAuth Authorization URL**—(optional) the URL where the user logs into the service.
        * **OAuth Access Token URL**—(optional) the URL where the request for the access token is made.
        * **OAuth Refresh Token URL**—(optional) the URL where refresh tokens can be exchanged for access tokens when old access tokens expire.
        * **URL**—the root URL of the OData service (for example, `http://MySite/*MyOrganization*`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SharePointOnline">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—your SharePoint Online user account.
        * **Password**—your SharePoint password.
        * **URL**—the root URL of the OData service (for example, `http://MySite/*MyOrganization*`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and OData, see [this information page](https://cdn.cdata.com/help/RDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Odoo
Source: https://docs.cloud.cdata.com/en/Data-Sources/Odoo



## Prerequisites

Connect AI may be able to detect the Odoo database name automatically from the web address. However, we recommend that you specify the name of the Odoo database and enter it in the **Database** field.

To find your Odoo database name:

<Steps>
  <Step>
    Log in to your Odoo Online account.
  </Step>

  <Step>
    Click your profile icon in the top-right corner and select **My Databases**. Your database name is listed in the table.
  </Step>
</Steps>

Alternatively, you can often see the database name in the subdomain of your URL. If your URL is `https://mycompany.odoo.com`, your database name is likely `mycompany`.

## Setup Guide

Follow these steps to connect Odoo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Odoo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the base **URL** of the Odoo site to which you are connecting (for example, `http://my.odoo.com`).
  </Step>

  <Step>
    Enter the Odoo username for authentication in the **User** field.
  </Step>

  <Step>
    Enter the **API Token** used to authenticate the user.
  </Step>

  <Step>
    (Optional but recommended) Enter the name of the Odoo **Database** to which you are connecting. The prerequisites explain how to find the database name.
  </Step>

  <Step>
    (Optional) Set **Check Permissions** to `False` to allow a user without permission to `ir.model.access` to access all models as tables.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Odoo, see [this information page](https://cdn.cdata.com/help/OEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Office 365
Source: https://docs.cloud.cdata.com/en/Data-Sources/Office365



## Setup Guide

Follow these steps to connect Office 365 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Office 365* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Office 365 sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Office 365 account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter your **OAuth Client Id**. This is in your Entra ID (formerly Azure AD) application settings.
      </Step>

      <Step>
        (Optional) Enter a **OAuthClientSecret**. This is in your Entra ID (formerly Azure AD) application settings.
      </Step>

      <Step>
        (Optional) Set the **OAuthJWTCert:** to the JWT certificate. This is a multi-line key.
        You must provide either an OAuth Client Secret OR OAuth JWT Cert to authenticate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Office 365, see [this information page](https://cdn.cdata.com/help/CXM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Okta
Source: https://docs.cloud.cdata.com/en/Data-Sources/Okta



## Setup Guide

Follow these steps to connect Okta to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Okta* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Okta **Domain**. When logged into your Okta account, your domain is included in the URL. For example, in the URL `https://dev-44876464.okta.com/enduser/settings`, the domain is 'dev-44876464.okta.com'.
  </Step>

  <Step>
    Enter the **OAuth Client Id** assigned when you registered for OAuth. This Id registers the custom application with the OAuth authorization server.
  </Step>

  <Step>
    Enter the **OAuth Client Secret** for your Okta account. This secret registers the custom application with the OAuth authorization server.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth JWT">
    <Steps>
      <Step>
        Enter the **OAuth JWT Cert** provided by Okta. This is a multi-line key.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type** from the drop-down list. This is the type of key store containing the JWT certificate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft OneDrive
Source: https://docs.cloud.cdata.com/en/Data-Sources/OneDrive



## Setup Guide

Follow these steps to connect Microsoft OneDrive to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft OneDrive* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Azure Tenant**—(optional) the Microsoft OneDrive tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
    * **Default Groups**—the default group context when accessing group-scoped resources. The default is *AllGroups*.
    * **Default User**—the default user context when accessing user-scoped resources. The default is *CurrentUser*.
    * **Group Id**—(optional) the Id of a Microsoft OneDrive group whose data you want to access.
    * **User Id**—(optional) the Id of a Microsoft OneDrive user whose data you want to access.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Microsoft OneDrive sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Microsoft OneDrive account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client ID assigned when you registered your custom OAuth application.
        * **OAuth Client Secret**—the client secret assigned to your custom OAuth application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your custom OAuth application.
        * **OAuth JWT Cert**—the name of the client certificate's JWT Certificate store. This is a multi-line key.
        * **OAuth JWT Cert Type**—the type of key store containing the JWT Certificate.
        * **OAuth JWT Cert Password**—the password for the OAuth JWT certificate used to access a password-protected certificate store.
        * **OAuth JWT Cert Subject**—the subject of the OAuth JWT certificate used to locate a matching certificate in the store.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft OneDrive, see [this information page](https://cdn.cdata.com/help/UOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft OneNote
Source: https://docs.cloud.cdata.com/en/Data-Sources/OneNote



## Setup Guide

Follow these steps to connect Microsoft OneNote to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft OneNote* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Microsoft OneNote sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Microsoft OneNote account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft OneNote account.
        * **OAuth Client Secret**—the client secret for your Microsoft OneNote account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft OneNote account.
        * **OAuth JWL Cert**—the contents of the JWT certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft OneNote, see [this information page](https://cdn.cdata.com/help/UNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle Financials Cloud
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleERP



## Setup Guide

Follow these steps to connect Oracle Financials Cloud to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle Financials Cloud* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Password**—the user password
    * **User**—the Oracle Financials Cloud username for authentication
    * **URL**—the URL to connect to, typically the URL of the Oracle Cloud Service. It is often in the format of [https://servername.fa.us2.oraclecloud.com](https://servername.fa.us2.oraclecloud.com).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle Eloqua
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleEloqua



## Setup Guide

Follow these steps to connect Oracle Eloqua to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle Eloqua* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **Company** name on the Oracle Eloqua account.
      </Step>

      <Step>
        Enter the Oracle Eloqua username for authentication in the **User** Field.
      </Step>

      <Step>
        In **Password**, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter your **OAuth Client Id**.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for that Id.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Oracle Eloqua sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Oracle Eloqua account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Oracle Eloqua, see [this information page](https://cdn.cdata.com/help/DUM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle HCM Cloud
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleHCM



## Setup Guide

Follow these steps to connect Oracle HCM Cloud to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle HCM Cloud* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Password**—the user password
    * **User**—the Oracle HCM Cloud username for authentication
    * **URL**—the URL of the account to connect to
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Oracle HCM Cloud, see [this information page](https://cdn.cdata.com/help/KMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleOci



## Setup Guide

Follow these steps to connect Oracle to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Connection String**. Copy one of the high, medium, or low connection strings available for your Oracle Autonomous Database, located in the **Database Connection** menu of the Oracle Autonomous Database. The string should be in the format shown. You can also connect to an Oracle self-hosted database.
  </Step>

  <Step>
    Enter the **User** and **Password** for the Oracle Autonomous Database.
  </Step>

  <Step>
    Click **Choose File** to upload the Oracle Wallet SSO file, `cwallet.sso`, found in the Oracle Wallet zip file. To download the Oracle Wallet zip file, go to the **Database Connection** menu in the Oracle Autonomous Database. This file is optional for an Oracle self-hosted database.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Oracle OCI, see [this information page](https://cdn.cdata.com/help/SOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle SCM
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleSCM



## Setup Guide

Follow these steps to connect Oracle SCM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle SCM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Password**—the user password
    * **User**—the Oracle SCM username for authentication
    * **URL**—the URL of the account to connect to
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Oracle SCM, see [this information page](https://cdn.cdata.com/help/KSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle Sales
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleSalesCloud



## Setup Guide

Follow these steps to connect Oracle Sales to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle Sales* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the Oracle Sales server **Host URL** used for logging in.
  </Step>

  <Step>
    Enter the Oracle Sales username for authentication in the **Username** field.
  </Step>

  <Step>
    In the **Password** field, enter the user password.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Oracle Sales, see [this information page](https://cdn.cdata.com/help/EOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle Service Cloud
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleServiceCloud



## Setup Guide

Follow these steps to connect Oracle Service Cloud to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle Service Cloud* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **URL**—the URL of the account to connect to
    * **User**—the Oracle Service Cloud username for authentication
    * **Password**—the user password
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Oracle Service Cloud, see [this information page](https://cdn.cdata.com/help/KOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Outreach
Source: https://docs.cloud.cdata.com/en/Data-Sources/Outreach



## Setup Guide

Follow these steps to connect Outreach to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Outreach* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Outreach sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Outreach account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Outreach, see [this information page](https://cdn.cdata.com/help/KRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PCA Accounting
Source: https://docs.cloud.cdata.com/en/Data-Sources/PCAAccounting



## Setup Guide

Follow these steps to connect PCA Accounting to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PCA Accounting* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Data Center** name for the PCA API server. For example, *west01*, *east02*, *west03*, *east04*, *aws*.
  </Step>

  <Step>
    Specify the **Default Data Area**, or the first connected Data Area. For example, *P20V01C081KON0001*.
  </Step>

  <Step>
    Specify the **API Version** to use. The default is `V1`.
  </Step>

  <Step>
    Select the **Product Code** of the PCA product to which you want to connect. The options are **Acc20**, **Kon20**, or **SAcc20**.
  </Step>

  <Step>
    Select the **Auth Scheme**, then follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the PCA Accounting sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your PCA Accounting account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the PCA Accounting username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Enter the **Service Id** used to connect to the PCA API server.
      </Step>

      <Step>
        Enter the **Service Password** for the above Service Id.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and PCA Accounting, see [this information page](https://cdn.cdata.com/help/OKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PCA Sales
Source: https://docs.cloud.cdata.com/en/Data-Sources/PCASales



## Setup Guide

Follow these steps to connect PCA Sales to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PCA Sales* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Data Center** name for the PCA API server.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Specify the **Default Data Area** to which you want to connect.
      </Step>

      <Step>
        Select the **Product Code** of the PCA to which you want to connect. The options are `Kon20` or `Acc20`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the PCA Sales sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your PCA Sales account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the PCA Sales username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Enter the **Service Id** used to connect to the PCA API server.
      </Step>

      <Step>
        Enter the **Service Password** for the above Service Id.
      </Step>

      <Step>
        Specify the **Default Data Area** to which you want to connect.
      </Step>

      <Step>
        Select the **Product Code** of the PCA to which you want to connect. The options are `Kon20` or `Acc20`.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and PCA Sales, see [this information page](https://cdn.cdata.com/help/OPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PayPal
Source: https://docs.cloud.cdata.com/en/Data-Sources/PayPal



## Setup Guide

Follow these steps to connect PayPal to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PayPal* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Schema** from the drop down list, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

### REST

<Steps>
  <Step>
    Enter the **OAuth Client Id** assigned when you registered your PayPal account for OAuth.
  </Step>

  <Step>
    Enter the **OAuth Client Secret** for your PayPal account.
  </Step>

  <Step>
    Set the **Use Sandbox** field to **True** only if you are using a sandbox account. Otherwise, leave it as **False**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

### SOAP

<Steps>
  <Step>
    Enter the PayPal username for authentication in the **User** field.
  </Step>

  <Step>
    In the **Password** field, enter the user password.
  </Step>

  <Step>
    Enter your **Signature**. To create a signature, in your PayPal business account navigate to **Profile** > **My Setting Tools**. In the API Access section click **Update**, and then **Request API Credentials** on the following page.
  </Step>

  <Step>
    Set the **Use Sandbox** field to **True** only if you are using a sandbox account. Otherwise, leave it as **False**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and PayPal, see [this information page](https://cdn.cdata.com/help/BPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Paylocity
Source: https://docs.cloud.cdata.com/en/Data-Sources/Paylocity



## Prerequisites

Before you can authenticate to Paylocity via OAuth, you must first obtain API access and register your desired callback URL with Paylocity. The callback URL for Connect AI is *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.

To register, contact either [service@paylocity.com](mailto:service@paylocity.com) or [sales@paylocity.com](mailto:sales@paylocity.com).

Once your access has been reviewed and approved, Paylocity provides you with OAuth credentials and access to either a Sandbox or a Production account. This access is necessary for authenticating your API requests.

Paylocity provides the following OAuth credentials.

* **client\_id**: The client\_id assigned to the registered OAuth application in the Paylocity developer portal. This value is used to set the **OAuthClientId**.
* **secret**: The secret assigned to the registered OAuth application in the Paylocity developer portal. This value is used to set the **OAuthClientSecret**. Note that Paylocity requires secrets to be rotated every 365 days. They send an email reminder of your secret expiring at 10 days before expiration and again at 5 days before expiration.

## Setup Guide

Follow these steps to connect Paylocity to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Paylocity* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **OAuth Client Id**–set to the client Id obtained in the prerequisites.
    * **OAuth Client Secret**—set to the client secret obtained in the prerequisites.
    * **RSA Public Key**—the RSA key associated with your Paylocity account. Only required if you want to execute Insert and Update statements.
    * **Key**—set this to the Base64-encoded AES symmetric key to use when encrypting content. Only required if the IV is set.
    * **IV**—set this to the Base64-encoded AES initialization vector (IV) to use when encrypting content. Only required if Key is also set.
    * **Authentication Model**–select how you want other users to access the data to this data source, either with shared authentication or with the user's own credentials (per-user authentication).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Paylocity, see [this information page](https://cdn.cdata.com/help/KPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PingOne
Source: https://docs.cloud.cdata.com/en/Data-Sources/PingOne



## Prerequisites

Complete these steps to create a custom OAuth application before configuring the connection:

<Steps>
  <Step>
    Sign in to your PingOne organization's admin console with your administrator account. Your organization's home page displays.
  </Step>

  <Step>
    In the left navigation pane, click **Environments**. A list of environments displays.
  </Step>

  <Step>
    Click the environment where you want your custom OAuth application to reside. (This should be the Administrators environment.) Note the environment ID. The is the value you enter as the **Worker App Environment Id** in Connect AI.
  </Step>

  <Step>
    Click **Manage Environment**. The home page of the environment you chose displays.
  </Step>

  <Step>
    In the left navigation pane, click **Applications**.
  </Step>

  <Step>
    Click the **+** button at the top left corner of the page. The console displays the New Application form.
  </Step>

  <Step>
    Provide an **Application Name** for the custom OAuth application.
  </Step>

  <Step>
    Set **Application Type** to **Worker**.
  </Step>

  <Step>
    Click **Save**. The console displays the Application Details for your new custom OAuth application. Note the **Client ID** and **Client Secret**. You enter them in the steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect PingOne to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PingOne* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Worker App Environment Id**, which is the ID of the PingOne environment in which your application resides.
  </Step>

  <Step>
    Select the **Region** where your PingOne organization data is hosted.
  </Step>

  <Step>
    (Optional) Specify a **Schema** to use. The available schemas are **Information** and dynamic environment schemas (one for each environment in your PingOne organization).
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the prerequisites.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the PingOne sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your PingOne account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the prerequisites.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Pinterest
Source: https://docs.cloud.cdata.com/en/Data-Sources/Pinterest



## Prerequisites

Pinterest requires a custom OAuth application to connect. Before you begin, create an application in the Pinterest developer portal to obtain an **OAuth Client Id** and **OAuth Client Secret**:

<Steps>
  <Step>
    Navigate to the [Pinterest developer portal](https://developers.pinterest.com/apps/) and sign in with your Pinterest credentials.
  </Step>

  <Step>
    Click **Create app**.
  </Step>

  <Step>
    Specify an app **Name** and **Description**, then click **Create**.
  </Step>

  <Step>
    In the app settings, locate the **Redirect URIs** section and enter the redirect URI used by Connect AI: *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save your changes, then select **View Client ID** to display your **Client ID** and **Client Secret**. These are the values you enter as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Pinterest to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Pinterest* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **OAuth Client Id**—the client ID assigned to your custom OAuth application.
    * **OAuth Client Secret**—the client secret assigned to your custom OAuth application.
    * **Ad Account Id**—(optional) the unique identifier of an Ad Account. If omitted, Connect AI selects the first Ad Account configured for the account.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Pinterest sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Pinterest account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Pinterest, see [this information page](https://cdn.cdata.com/help/UPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Pipedrive
Source: https://docs.cloud.cdata.com/en/Data-Sources/Pipedrive



## Setup Guide

Follow these steps to connect Pipedrive to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Pipedrive* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Company Domain** used for accessing your Pipedrive account. This is visible in the URL of your Developer Sandbox account.
  </Step>

  <Step>
    Enter the **Schema** to use, API V1 or V2. **Note:** The V2 API is in a beta phase.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **API Token** used for accessing your Pipedrive account.
        To obtain an API Token, do the following:

        1. Open the Pipedrive portal.

        2. At the top right corner of the page, click the account name. Pipedrive displays a drop-down list.

        3. Navigate to **Company Settings** > **Personal Preferences** > **API** > **Generate Token**.

        4. Record the value of the generated API token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your Pipedrive account for OAuth.
        * **OAuth Client Secret**—the client secret assigned when you registered your Pipedrive account for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PostgreSQL
Source: https://docs.cloud.cdata.com/en/Data-Sources/PostgreSQL



## Prerequisites

#### Whitelist CData IPs

To establish a connection to PostgreSQL, you need to allow access to PostgreSQL via CData’s IP. When hosting PostgreSQL behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure PostgreSQL Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect PostgreSQL to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PostgreSQL* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    If your PostgreSQL connection is behind a firewall, set the **Connection Type** to **SSH Tunnel** and follow the instructions in [SSH Tunnel Instructions](#ssh-tunnel-instructions). Then continue with these instructions. Otherwise, leave the **Connection Type** as **Direct**.
  </Step>

  <Step>
    In the **Server** field, enter the host name or IP address of the PostgreSQL server.
  </Step>

  <Step>
    <Note>
      **Note:** If your PostgreSQL database has a self-signed certificate, you must copy the self-signed certificate into the **Advanced Settings** > **SSL Server Cert** field.
    </Note>
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        In the **User** field, enter the PostgreSQL username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        (Optional) Enter the name of the PostgreSQL **Database**. If none is entered, the user's default database is used.
      </Step>

      <Step>
        (Optional) Specify the port for connecting to the PostgreSQL server in the **Port** field. This is set to 5432 by default.
      </Step>

      <Step>
        In PostgreSQL, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        In the **User** field, enter the PostgreSQL username for authentication.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        (Optional) Enter the name of the PostgreSQL **Database**. If none is entered, the user's default database is used.
      </Step>

      <Step>
        (Optional) Specify the port for connecting to the PostgreSQL server in the **Port** field. This is set to 5432 by default.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the PostgreSQL sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your PostgreSQL account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        In PostgreSQL, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzurePassword">
    <Steps>
      <Step>
        In the **User** field, enter the PostgreSQL username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        (Optional) Enter the name of the PostgreSQL **Database**. If none is entered, the user's default database is used.
      </Step>

      <Step>
        (Optional) Specify the port for connecting to the PostgreSQL server in the **Port** field. This is set to 5432 by default.
      </Step>

      <Step>
        In PostgreSQL, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        In the **User** field, enter the PostgreSQL username for authentication.
      </Step>

      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        (Optional) Enter the **AWS External Id** only if emulating a different role.
      </Step>

      <Step>
        (Optional) Enter the name of the PostgreSQL **Database**. If none is entered, the user's default database is used.
      </Step>

      <Step>
        (Optional) Specify the port for connecting to the PostgreSQL server in the **Port** field. This is set to 5432 by default.
      </Step>

      <Step>
        In PostgreSQL, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## SSH Tunnel Instructions

If your PostgreSQL data source is behind a firewall, follow these instructions.

<Steps>
  <Step>
    Click **Connection Type** of **SSH Tunnel**.
  </Step>

  <Step>
    Enter the following information:

    * **SSH Server**–enter the name of the SSH server.
    * **SSH Port**–enter the SSH port. The default value is 22.
    * **SSH Auth Mode**–enter the authentication mode of **Password** or **Public\_Key**.
      * If **Password**, enter the **SSH User** name and **SSH Password**.
      * If **Public\_Key**, enter the **SSH User** name, **SSH Client Cert**, and **SSH Client Cert Password** (optional). Only PEMKEY\_BLOB is available as the **SSH Client Cert Type**. The **SSH Client Cert** is required, and is a valid private key. Enter the **SSH Client Cert Password** if the SSH client certificate has a password.
  </Step>

  <Step>
    Continue with the authentication instructions in the [Setup Guide](#setup-guide).
  </Step>
</Steps>

## Private Cloud Connector Connection

PostgreSQL is a supported connector with Private Cloud Connector, which acts as a bridge between your on-premises data and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information. Once you set up the gateway, you can select the **Connection Type** of **Private Cloud Connector**. Then enter **Location Name** of the gateway and the PostgreSQL authentication information.

## More Information

For more information about interactions between Connect AI and PostgreSQL, see [this information page](https://cdn.cdata.com/help/FPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Power BI XMLA
Source: https://docs.cloud.cdata.com/en/Data-Sources/PowerBIXMLA



## Setup Guide

Follow these steps to connect Power BI XMLA to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Power BI XMLA* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Power BI XMLA sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Power BI XMLA account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Power BI XMLA, see [this information page](https://cdn.cdata.com/help/LGJ/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Presto
Source: https://docs.cloud.cdata.com/en/Data-Sources/Presto



## Setup Guide

Follow these steps to connect Presto to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Presto* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **User**—the Presto username for authentication
    * **Password**—the user password
    * **Port**—the port for connecting to the Presto server
    * **Server**—the host name or IP address of the Presto REST server
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Presto, see [this information page](https://cdn.cdata.com/help/ORM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Quickbase
Source: https://docs.cloud.cdata.com/en/Data-Sources/QuickBase



## Setup Guide

Follow these steps to connect Quickbase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Quickbase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        For Basic authentication, enter the following information:

        * **User**—the Quickbase username for authentication.
        * **Password**—the user password.
        * **Application Token**—(optional) the application token is located at **MyAppName** > **Settings** > **App properties** > **Advanced settings** > **Security options** > **Require Application Tokens** > **Manage Application Token**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the **User Token**. You can find the User Token under **Quickbase** > **My Preferences** > **My User Information** > **Manage User Tokens**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Quickbase, see [this information page](https://cdn.cdata.com/help/GUM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# QuickBooks
Source: https://docs.cloud.cdata.com/en/Data-Sources/QuickBooks



## Prerequisites

Because the QuickBooks Gateway runs on your local machine, you must also do the following:

* Set up the Private Cloud Connector on the same network as your QuickBooks machine. This allows Connect AI to reach the local machine. The Private Cloud Connector acts as a secure tunnel between your on-premises network and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information.
* Install and configure the CData QuickBooks Gateway on the machine that hosts QuickBooks Desktop as follows:

<Steps>
  <Step>
    [Download](https://www.cdata.com/products/quickbooksgateway/) and install the CData QuickBooks Gateway on the machine where QuickBooks Desktop is installed.
  </Step>

  <Step>
    Launch QuickBooks Desktop and ensure that the company file you want to access is open.
  </Step>

  <Step>
    Start the QuickBooks Gateway. By default, it listens at [http://localhost:8166](http://localhost:8166).
  </Step>

  <Step>
    Note the **URL**, **User**, and **Password** configured in the QuickBooks Gateway. You will enter these in the setup steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect QuickBooks to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *QuickBooks* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Connection Type** of **Private Cloud Connector**.
  </Step>

  <Step>
    Select a **Location Name** of the gateway you created in the prerequisites.
  </Step>

  <Step>
    Enter the **URL** where the QuickBooks Gateway is running (for example, *[http://localhost:8166](http://localhost:8166)*). This is the endpoint the connector uses to communicate with QuickBooks Desktop. The **URL** you enter is resolved through the Private Cloud Connector tunnel.
  </Step>

  <Step>
    Enter the **User** and **Password** required to authenticate the connection to the QuickBooks Gateway.
  </Step>

  <Step>
    (Optional) Enter the **Application Name** of the application connecting to QuickBooks. The default value is *CData QuickBooks Connector*.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and QuickBooks, see [this information page](https://cdn.cdata.com/help/RQM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# QuickBooks Online
Source: https://docs.cloud.cdata.com/en/Data-Sources/QuickBooksOnline



CData Connect AI includes embedded OAuth credentials for QuickBooks Online that simplify the connection process. With the embedded credentials, you can connect to QuickBooks Online without creating a custom OAuth application.

Note that the embedded OAuth credentials have limited functionality due to monthly query limits imposed by Intuit. If you exceed the monthly query limit, queries will return an error until the limit resets.

## Create a Custom OAuth Application

To avoid monthly query limits and experience full functionality, create a custom OAuth application in QuickBooks Online. This is recommended for production use or any scenario where you expect regular or high-volume queries.

To create a custom OAuth application in the Intuit Developer Portal, follow these steps:

<Steps>
  <Step>
    Log in to the Intuit Developer Portal.

    * Go to: [https://developer.intuit.com](https://developer.intuit.com/).
    * Sign in with your Intuit account (or create one if you don't already have one).
  </Step>

  <Step>
    Create a new app.

    * From the dashboard, open an existing **Workspace** or create a new one if you do not yet have one. In the **Workspace**, click the **+** button to create a new app.
  </Step>

  <Step>
    Set up app details.

    * The **Type** screen should automatically pick **QuickBooks Online and Payments**.
    * On the **Basic info** screen, provide a name for your application (for example, *CData QuickBooks Integration*).
    * On **Permissions**, select the **com.intuit.quickbooks.accounting** permission.
    * Click **Done** and **Confirm** the creation of your application. Afterwards, **Open** your application.
  </Step>

  <Step>
    Configure the redirect URI.

    * In the App Overview of your application, go to **Settings** > **Redirect URIs**. Click **Add URI** and add the following redirect URI (used by CData connectors): *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
    * **Save** the configuration.
  </Step>

  <Step>
    Set the Regulated Industries.

    * Go to **Settings** > **Regulated Industries**. Select **None of the above**, then **Save**.
    * This will shorten the questionnaire in the next step. Intuit recommends waiting 30 minutes after saving to ensure this takes effect.
  </Step>

  <Step>
    Submit the app assessment for production keys.

    * Intuit requires an assessment to be submitted for every application, even if it is used for internal use in your own company. In the App Overview, navigate to the **Compliance** tab. Click **Start questionnaire**.
    * You should only see two tabs: **General Questions** and **App Information**. If you see more than two tabs, please wait for Step 5 to take effect.
    * Under **General Info**, answer all the questions as per your organization's specifications.
    * Under **App Information**, select **You were asked to create this app in order to get credentials/keys to be used on another platform that integrates with QuickBooks** for question 1. Provide the following link: *[https://www.cdata.com/drivers/qbonline/](https://www.cdata.com/drivers/qbonline/)*.
    * Click **Submit** once you are done and wait to receive the **Application Assessment - Questionnaire Completed** email.
  </Step>

  <Step>
    Retrieve your credentials.

    * Once Intuit has approved your application, copy the **Client ID** and **Client Secret** generated for your app from the **Keys and Credentials** > **Production** section of the App Overview. You enter these values in the setup steps below.
  </Step>
</Steps>

## Setup Guide

<Note>Each connection to QuickBooks Online can only connect to one company.</Note>

Follow these steps to connect QuickBooks Online to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *QuickBooks Online* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set **Use Sandbox** to **True** only if you are using a sandbox account. Otherwise, leave it as **False**.
  </Step>

  <Step>
    Select the **Country Code** that best matches your location.
  </Step>

  <Step>
    If you are using a custom OAuth application, click **Advanced Settings** and enter the **Client Id** and **Client Secret** obtained from the prerequisites.
  </Step>

  <Step>
    If you are using embedded credentials, click **Sign in** to connect using those credentials. This action opens the QuickBooks Online sign-in page in a new tab.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## Common Queries

The **Data Model** tab, in addition to the QuickBooks Online data model, contains a list of common queries used for QuickBooks Online. Expand **Common Queries** to view the SQL query templates, such as **Customer Outstanding Balances Report**. Click the ellipsis next to the query title and click **Execute Query**.

<Frame>
  <img alt="" />
</Frame>

The [Data Explorer](/en/Data-Explorer) screen appears, displaying the SQL query. From there, you can execute, edit, or save the query. You can also save the query as a derived view, so that you can access it from external integrations.

## More Information

For more information about interactions between Connect AI and QuickBooks Online, see [this information page](https://cdn.cdata.com/help/RNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# RSS
Source: https://docs.cloud.cdata.com/en/Data-Sources/RSS



## Setup Guide

Follow these steps to connect RSS to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *RSS* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI**, which is the Uniform Resource Identifier of the feed.
  </Step>

  <Step>
    Select the **Auth Scheme** used for HTTP authentication. Accepted entries are **None**, **Basic**, **Digest**, **NTLM**, and **Negotiate**.
  </Step>

  <Step>
    (Optional) Enter the **Auth Token** used for authentication. This is required when **Auth Scheme** is set to any value other than **None**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and RSS, see [this information page](https://cdn.cdata.com/help/RRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Reckon
Source: https://docs.cloud.cdata.com/en/Data-Sources/Reckon



## Setup Guide

Follow these steps to connect Reckon to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Reckon* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication

<Steps>
  <Step>
    Enter your Reckon Gateway **User** and **Password**.
  </Step>

  <Step>
    Enter the **URL** where your Reckon Gateway is running (for example, *[http://localhost:8166](http://localhost:8166)*).
  </Step>

  <Step>
    (Optional) Enter an **Application Name** to identify this connection to Reckon. The default is *CData Reckon Connector*.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information on configuring the Reckon data source, see [this information page](https://cdn.cdata.com/help/BAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Reckon Accounts Hosted
Source: https://docs.cloud.cdata.com/en/Data-Sources/ReckonAccountsHosted



## Setup Guide

Follow these steps to connect Reckon Accounts Hosted to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Reckon Accounts Hosted* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Reckon Accounts Hosted **User** name.
  </Step>

  <Step>
    Enter your Reckon Accounts Hosted **Password**.
  </Step>

  <Step>
    Enter the complete path of where your **Company File** is located, for example, *Q:/MyCompanyFile.qbw*. The company file usually has a `.qbw` or `.qba` extension.
  </Step>

  <Step>
    Enter the **Country Version** of Reckon Accounts Hosted, for example, *2018.R2.AU*.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Reckon Accounts Hosted sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Reckon Accounts Hosted account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Redis
Source: https://docs.cloud.cdata.com/en/Data-Sources/Redis



## Setup Guide

Follow these steps to connect Redis to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Redis* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the **Server** hosting the Redis instance.
  </Step>

  <Step>
    Enter the port for connecting to the Redis server into **Port**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        In Redis, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ACL">
    <Steps>
      <Step>
        In the **User** field, enter the Redis username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        In Redis, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Redis, see [this information page](https://cdn.cdata.com/help/EIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Rippling
Source: https://docs.cloud.cdata.com/en/Data-Sources/Rippling



## Prerequisites

Before you can connect to Connect AI, you must generate an API token in Rippling.

<Steps>
  <Step>
    Go to [app.rippling.com](https://app.rippling.com) and sign in with your admin account.
  </Step>

  <Step>
    Navigate to the API Tokens app. You can find it by searching for *API Tokens*, navigating to **Settings**, or going directly to [app.rippling.com/api-tokens/](https://app.rippling.com/api-tokens/).
  </Step>

  <Step>
    Create a new API token by providing a name, a unique identifier, and selecting the API version.
  </Step>

  <Step>
    Configure the API permissions based on the required access. Select only the scopes your integration needs (for example, `workers.read`, `users.read`, `departments.read`).
  </Step>

  <Step>
    Copy and securely store the token value. It will not be displayed again.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Rippling to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Rippling* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of your Rippling endpoint (for example, *[https://rest.ripplingapis.com/](https://rest.ripplingapis.com/)*).
  </Step>

  <Step>
    Enter the **API Token** that you obtained in the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Ariba Procurement
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPAribaProcurement



## Prerequisites

Before you can connect SAP Ariba Procurement, you must create a custom OAuth app as follows:

<Steps>
  <Step>
    Go to the [SAP Developer Portal](https://developer.ariba.com/) and sign in.
  </Step>

  <Step>
    Click **Manage** (bottom icon on the left).
  </Step>

  <Step>
    Click the **+** button next to the search field.
  </Step>

  <Step>
    Fill in **Application Name** and **Description**, and then click **Submit**.
  </Step>

  <Step>
    Click **Actions** > **Request API Access**.
  </Step>

  <Step>
    Select the API you want to retrieve data from. This corresponds to the API connection property.
  </Step>

  <Step>
    Select your realm.
  </Step>

  <Step>
    Click **Submit**. Wait until the request is approved.
  </Step>

  <Step>
    Once approved, click **Actions** > **Generate OAuth Secret**.
  </Step>

  <Step>
    Save the values displayed for **API key**, **OAuth Client Id**, and **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SAP Ariba Procurement to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Ariba Procurement* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **API Key**—the API key created in the prerequisites.
    * **API**—the API you want to retrieve data from.
    * **ANID**—your SAP Ariba Network Id. [Find your ANID as a buyer](https://support.ariba.com/item/view/187831) or [find your ANID as a supplier](https://support.ariba.com/item/view/KB0392438).
    * **OAuth Client Id**—the OAuth client Id from the prerequisites.
    * **OAuth Client Secret**—the OAuth client secret from the prerequisites.
    * **Max Threads**—the maximum number of concurrent requests the provider can execute to SAP Ariba.
    * **Environment**—the environment to use when connecting to SAP Ariba, either PRODUCTION or TEST.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Ariba Procurement, see [this information page](https://cdn.cdata.com/help/PAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Ariba Sourcing
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPAribaSource



## Prerequisites

Before you can connect SAP Ariba Sourcing, you must create a custom OAuth app as follows:

<Steps>
  <Step>
    Go to the [SAP Developer Portal](https://developer.ariba.com/) and sign in.
  </Step>

  <Step>
    Click **Manage** (bottom icon on the left).
  </Step>

  <Step>
    Click the **+** button next to the search field.
  </Step>

  <Step>
    Fill in **Application Name** and **Description**, and then click **Submit**.
  </Step>

  <Step>
    Click **Actions** > **Request API Access**.
  </Step>

  <Step>
    Select the API you want to retrieve data from. This corresponds to the API connection property.
  </Step>

  <Step>
    Select your realm.
  </Step>

  <Step>
    Click **Submit**. Wait until the request is approved.
  </Step>

  <Step>
    Once approved, click **Actions** > **Generate OAuth Secret**.
  </Step>

  <Step>
    Save the values displayed for **API key**, **OAuth Client Id**, and **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SAP Ariba Sourcing to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Ariba Sourcing* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **API Key**—the API key created in the prerequisites.
    * **Realm**—the realm from which you want to access data.
    * **API**—the API you want to retrieve data from.
    * **Data Center**—the data center where your account's data is hosted.
    * **Type Detection Scheme**—select whether to return all columns as the string type (None) or scan rows to determine the data type (RowScan).
    * **Include Custom Fields**—toggle on to include custom fields from SAP Ariba tables.
    * **OAuth Client Id**—the OAuth client Id from the prerequisites.
    * **OAuth Client Secret**—the OAuth client secret from the prerequisites.
    * **Max Threads**—the maximum number of concurrent requests the provider can execute to SAP Ariba.
    * **Environment**—the environment to use when connecting to SAP Ariba, either PRODUCTION or TEST.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Ariba Sourcing, see [this information page](https://cdn.cdata.com/help/PBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Business Objects BI
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPBusinessObjectsBI



## Setup Guide

Follow these steps to connect SAP Business Objects BI to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Business Objects BI* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Under **Authentication**, enter the **URL** of the REST API exposed by the SAP Business Objects BI. You can find the correct URL in the Central Management Console of SAP Business Objects BI. Select **Applications**, and then double-click **RESTful Web Service** to view the access URL. By default, it is `http://[SERVER-NAME]:6405/biprws`.
  </Step>

  <Step>
    Enter the SAP Business Objects BI schema to connect to:

    * **SAPBusinessObjectsBI**—exposes SAP Universes as views for direct querying and reporting.
    * **Administration**—includes views, tables, and procedures for admin-level operations.
    * **Reporting**—provides report-specific views, tables, and procedures.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the SAP Business Objects BI username for authentication.
        * **Password**—the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Enterprise">
    <Steps>
      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="LDAP">
    <Steps>
      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="WinAD">
    <Steps>
      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="CyberArk">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the SAP Business Objects BI username for authentication.
        * **Password**—the user password.
        * **SSO Login URL**—enter the SSO provider's login URL.
        * **SSO Properties**—enter any additional property-value pairs required to connect to the SSO provider, separated by semicolons.
        * **SSO Exchange Url**—enter the URL used for consuming the SAML response and exchanging it for service-specific credentials.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAP Business Objects BI, see [this information page](https://cdn.cdata.com/help/GJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Business One
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPBusinessOne



## Prerequisites

If your SAP Business One server is on a private network or behind a firewall, set up the Private Cloud Connector on the same network as your SAP Business One server. The Private Cloud Connector acts as a secure tunnel between your on-premises network and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information.

## Setup Guide

Follow these steps to connect SAP Business One to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Business One* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Connection Type**:

    * Select **Direct** if your SAP Business One server is publicly accessible.
    * Select **Private Cloud Connector** if your SAP Business One server is on a private network or behind a firewall.
  </Step>

  <Step>
    (Private Cloud Connector only) Select the **Location Name** of the gateway you set up in the prerequisites.
  </Step>

  <Step>
    Enter the following information:

    * **Company DB**—the SAP Business One company database
    * **Password**—the user password
    * **User**—the SAP Business One username for authentication
    * **URL**—the URL to the SAP Business One service layer root, in the format `https://[IP-address]:[port]/b1s/[version]` (for example, `https://192.168.123.132:50000/b1s/v1`).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Business One, see [this information page](https://cdn.cdata.com/help/FVM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Business Warehouse
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPBusinessWarehouse



## Setup Guide

Follow these steps to connect SAP Business Warehouse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Business Warehouse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** used to connect to the SAP Business Warehouse.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="Basic">
    This method uses HTTP Basic authentication.

    <Steps>
      <Step>
        Enter the **User**, which is your SAP Business Warehouse user ID.
      </Step>

      <Step>
        Enter the **Password** for your SAP Business Warehouse account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    This method negotiates an authentication mechanism with the server.

    <Steps>
      <Step>
        Enter the **User**, which is your SAP Business Warehouse user ID.
      </Step>

      <Step>
        Enter the **Password** for your SAP Business Warehouse account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>
        No additional settings are required for this authentication mode.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP ByDesign
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPByDesign



## Setup Guide

Follow these steps to connect SAP ByDesign to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP ByDesign* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** to your system host name. This URL should conform to the following format: `https://my999999.businessbydesign.cloud.sap;`.
  </Step>

  <Step>
    Enter the SAP ByDesign username for authentication in the **User** field.
  </Step>

  <Step>
    In the **Password** field, enter the user password.
  </Step>

  <Step>
    Select the **Service Type** from `AnalyticsService`, `CustomService`, or `ODataDataSource`.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP ByDesign, see [this information page](https://cdn.cdata.com/help/UYM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Concur
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPConcur



## Setup Guide

Follow these steps to connect SAP Concur to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Concur* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Create a custom OAuth application in SAP Concur.

    * You may need to contact your Partner Enablement Manager or Partner Account Manager for SAP Concur for this step.
    * Once the application is created, copy down your clientId and clientSecret.
  </Step>

  <Step>
    In Connect AI, select a region.
  </Step>

  <Step>
    Choose an **Auth Scheme**.

    * If you choose **OAuth**, enter the following information.
      * **OAuth Client Id**—your clientId from the custom OAuth application.
      * **OAuth Client Secret**—your clientSecret from the custom OAuth application.
    * If you choose **OAuthPassword**, enter the following information.
      * **Username**—the SAP Concur username for authentication.
      * **Password**—the user password.
      * **OAuth Client Id**—enter your clientId from the custom OAuth application.
      * **OAuth Client Secret**—enter your clientSecret from the custom OAuth application.
    * If you choose **CompanyLevelAuth**, enter the following information.
      * **CompanyId**—enter the unique identifier for your company.
      * **Company Request Token**—enter your company request token. To obtain one, use the Company Request Token tool, or contact SAP Concur support.
      * **OAuth Client Id**—your clientId from the custom OAuth application.
      * **OAuth Client Secret**—your clientSecret from the custom OAuth application.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the SAP Concur sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your SAP Concur account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Concur, see [this information page](https://cdn.cdata.com/help/FNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Fieldglass
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPFieldglass



## Prerequisites

Please contact your SAP Fieldglass representative to obtain an Environment URL, OAuth Client Id, and OAuth Client Secret.

## Setup Guide

Follow these steps to connect SAP Fieldglass to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Fieldglass* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Environment URL**–the instance where SAP Fieldglass is located, for example, `https://myinstance.com`.
    * **OAuth Client Id**–the client Id assigned to your custom OAuth application.
    * **OAuth Client Secret**–the confidential client secret assigned to your custom OAuth Application.
    * **Connector Data Format**–the data format for downloaded data: CSV or JSON.
    * **APIKey**–(optional) the API key used to authenticate to SAP Fieldglass. If you encounter an error indicating that an API key is required, you can request one from SAP Fieldglass administration or log in to the SAP Fieldglass Integration Tools and click **Create API Application**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Fieldglass, see [this information page](https://cdn.cdata.com/help/UFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Gateway
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPGateway



## Setup Guide

Follow these steps to connect SAP Gateway to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Gateway* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** for your SAP Gateway environment or the full URL of the OData service. Any additional properties must be added using **Custom URL Params**.
  </Step>

  <Step>
    (Optional) Enter the service **Namespace** you want to retrieve data from. This is only required if the service is not specified in the **URL**.
  </Step>

  <Step>
    (Optional) Enter the **Service**, which is a comma-delimited list of services you want to retrieve data from. If the service is set in the **URL**, this property is ignored. In cases where the service is not set in the URL or in **Service**, the SAP Gateway's catalog service is used to discover all available services.
  </Step>

  <Step>
    (Optional) Enter any **Custom URL Params** to be included with the HTTP request. The parameters should be in the form *field1=value1\&field2=value2\&field3=value3*.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User** Id for the authenticating user.
      </Step>

      <Step>
        Enter the **Password** for the authenticating user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned to your custom OAuth application. This Id is required to identify the application to the OAuth authorization server during authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application. This value is used to authenticate the custom application to the OAuth authorization server.
      </Step>

      <Step>
        Enter the **Scope**, or permission scopes, in space separated values. Scopes define what kind of access the authenticating user has, such as read or read/write. Scopes are required for OAuth 2.0.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the **API Key** of the application you have created.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Set authentication to **OAuthPKCE** to use the Proof Key of Code Exchange (PKCE) extension of the standard OAuth2 flow. Set your own PKCEVerifier or let the driver automatically generate one for you.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SAPBTP">
    <Steps>
      <Step>
        In **Advanced Settings**, enter the **Destination URL** of the SAP BTP destination source. This URL is found in the service key of your Destination Service instance in the SAP BTP Cockpit, in the **URI** field.
      </Step>

      <Step>
        In **Advanced Settings**, enter the **Destination Name** of the SAP BTP destination to retrieve the authentication details from.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Private Cloud Connector Connection

SAP Gateway is a supported connector with Private Cloud Connector, which acts as a bridge between your on-premises data and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information. Once you set up the gateway, you can select the **Connection Type** of **Private Cloud Connector**. Then enter **Location Name** of the gateway and the SAP Gateway authentication information.

## More Information

For more information about interactions between Connect AI and SAP Gateway, see [this information page](https://cdn.cdata.com/help/GCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP HANA
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPHANA



## Prerequisites

In SAP HANA, add the Connect AI static IP addresses to your connection whitelist.

## Setup Guide

Follow these steps to connect SAP HANA to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP HANA* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the SAP HANA username for authentication
        * **Password**—the user password
        * **Database**—the name of the SAP HANA database
        * **Port**—the port for connecting to the SAP HANA server
        * **Server**—the host name or IP address of the server running the SAP HANA database
        * **Schema**—(Optional) the SAP database schema
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the SAP HANA username for authentication
        * **Password**—the user password
        * **SSO Properties**—format these properties like 'SSOProperty1=value1;SSOProperty2=value2;SSOProperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
        * **Database**—the name of the SAP HANA database
        * **Port**—the port for connecting to the SAP HANA server
        * **Server**—the host name or IP address of the server running the SAP HANA database
        * **Schema**—(Optional) the SAP database schema
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAP HANA, see [this information page](https://cdn.cdata.com/help/SNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP HANA XSA
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPHanaXSA



## Prerequisites

Complete these steps before configuring the connection (OAuth and OAuthPassword only):

<Steps>
  <Step>
    In your SAP HANA XSA environment, create an OAuth client through the XSUAA service.
  </Step>

  <Step>
    From the XSUAA service instance, retrieve the client ID, client secret, and XSUAA URL. You enter these values in the steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SAP HANA XSA to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP HANA XSA* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of the OData service endpoint.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the following information:

        * **User**–the SAP HANA XSA username for authentication.
        * **Password**–the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**–the client ID from your XSUAA service instance.
        * **OAuth Client Secret**–the client secret from your XSUAA service instance.
        * **XSUAAURL**–(optional) the URL from which to retrieve the OAuth access token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the following information:

        * **User**–the SAP HANA XSA username for authentication.
        * **Password**–the authenticating user's password.
        * **OAuth Client Id**–the client ID from your XSUAA service instance.
        * **OAuth Client Secret**–the client secret from your XSUAA service instance.
        * **XSUAAURL**–(optional) the URL from which to retrieve the OAuth access token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAP HANA XSA, see [this information page](https://cdn.cdata.com/help/HHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Hybris Cloud for Customer
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPHybrisC4C



## Setup Guide

Follow these steps to connect SAP Hybris Cloud for Customer to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Hybris Cloud for Customer* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Choose an **Auth Scheme**.

    * If you choose **Basic**, enter the following information.
      * **User**—the SAP Hybris Cloud for Customer username for authentication.
      * **Password**—the user password.
      * **Tenant**—the tenant to which you want to connect.
    * If you choose **AzureAD**, enter the following information.
      * **SSO Properties**—Single Sign-On (SSO) properties formatted like `SSOProperty1=value1;SSOProperty2=value2;`.
      * **Tenant**—the tenant to which you want to connect.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Hybris Cloud for Customer, see [this information page](https://cdn.cdata.com/help/OHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP SuccessFactors
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPSuccessFactors



## Prerequisites

Before you create the connection, gather the following information from your SAP SuccessFactors instance:

### Server URL

The URL of the server where your SAP SuccessFactors instance is hosted depends on your environment (production or preview) and data center location.

<Steps>
  <Step>
    Sign in to your SAP SuccessFactors instance and note the subdomain in the browser address bar (for example, `salesdemo4` in `https://salesdemo4.successfactors.com`).
  </Step>

  <Step>
    Open the [List of SAP SuccessFactors API Servers](https://help.sap.com/docs/successfactors-platform/sap-successfactors-api-reference-guide-odata-v2/list-of-sap-successfactors-api-servers) and find the row that matches your subdomain.
  </Step>

  <Step>
    Copy the corresponding **API Server URL** (for example, `https://api4.successfactors.com`). This is the value you enter for **URL** when configuring the connection.
  </Step>
</Steps>

If you cannot determine the correct API server, contact your SAP administrator or SAP Support.

### Company Id

<Steps>
  <Step>
    Sign in to your SAP SuccessFactors instance.
  </Step>

  <Step>
    Click your profile image in the upper-right corner, then select **Show version information**.
  </Step>

  <Step>
    In the dialog that opens, copy the value next to **Company ID**. This is the value you enter for **Company Id** when configuring the connection.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SAP SuccessFactors to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP SuccessFactors* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of the server where the SAP SuccessFactors instance is hosted. You located this information in the prerequisites.
  </Step>

  <Step>
    Enter the SAP SuccessFactors username for authentication in the **User** field.
  </Step>

  <Step>
    Enter your unique **Company Id** that you located in the prerequisites.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **Password** for the **User** entered above.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth Client">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your SAP SuccessFactors account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your SAP SuccessFactors account for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthSAML2">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your SAP SuccessFactors account for OAuth.
      </Step>

      <Step>
        Enter the PEM **Private Key** certificate downloaded upon registering your OAuth Client Application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAP SuccessFactors, see [this information page](https://cdn.cdata.com/help/GBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP SuccessFactors LMS
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPSuccessFactorsLMS



## Prerequisites

Before you create the connection, gather the following information from your SAP SuccessFactors instance:

### Server URL

The URL of the server where your SAP SuccessFactors instance is hosted depends on your environment (production or preview) and data center location.

<Steps>
  <Step>
    Sign in to your SAP SuccessFactors instance and note the subdomain in the browser address bar (for example, `salesdemo4` in `https://salesdemo4.successfactors.com`).
  </Step>

  <Step>
    Open the [List of SAP SuccessFactors API Servers](https://help.sap.com/docs/successfactors-platform/sap-successfactors-api-reference-guide-odata-v2/list-of-sap-successfactors-api-servers) and find the row that matches your subdomain.
  </Step>

  <Step>
    Copy the corresponding **API Server URL** (for example, `https://api4.successfactors.com`). This is the value you enter for **URL** when configuring the connection.
  </Step>
</Steps>

If you cannot determine the correct API server, contact your SAP administrator or SAP Support.

### Company Id

<Steps>
  <Step>
    Sign in to your SAP SuccessFactors instance.
  </Step>

  <Step>
    Click your profile image in the upper-right corner, then select **Show version information**.
  </Step>

  <Step>
    In the dialog that opens, copy the value next to **Company ID**. This is the value you enter for **Company Id** when configuring the connection.
  </Step>
</Steps>

### OAuth Credentials

Next, obtain a set of credentials related to your account's OAuth application.

<Steps>
  <Step>
    Log in to SAP SuccessFactors. Open the page selection menu at the top of the page, to the left of the search bar. The menu label is **Home** when you log in to the homepage. Click **Learning**.
  </Step>

  <Step>
    On the **Learning** page, open the **Dashboards** menu and click **Learning Administration**.
  </Step>

  <Step>
    On the **Learning Administration** page, click **System Administration** > **Application Administration** > **OAuth Token Server**. Note the value of the **Company ID** and the **Client ID**.
  </Step>

  <Step>
    Click **Generate a new Client Secret**. Note the value in the **Newly Generated Client Secret** field. This value is only displayed once, immediately after a new client secret is generated.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SAP SuccessFactors LMS to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP SuccessFactors LMS* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of the server where the SAP SuccessFactors instance is hosted (for example, *[https://api4.successfactors.com](https://api4.successfactors.com)*). You located this information in the prerequisites.
  </Step>

  <Step>
    Enter your unique **Company Id** that you located in the prerequisites.
  </Step>

  <Step>
    Enter the user Id for the authenticating user in the **User** field.
  </Step>

  <Step>
    Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application (obtained in the prerequisites).
  </Step>

  <Step>
    Enter the **OAuth Client Secret** assigned to your custom OAuth application (obtained in the prerequisites).
  </Step>

  <Step>
    From the **User Type** drop-down list, select the user type that uses the LMS microservices (**Admin** or **User**).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAS Data Sets
Source: https://docs.cloud.cdata.com/en/Data-Sources/SASDataSets



## Setup Guide

Follow these steps to connect SAS Data Sets to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAS Data Sets* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI** for the SAS resource location.
  </Step>

  <Step>
    Select the **Connection Type**, which specifies the file storage service, server, or file access protocol through which your SAS Data Sets files are stored and retrieved.
  </Step>
</Steps>

## Connection Types

<Tabs>
  <Tab title="Amazon S3">
    <Steps>
      <Step>
        Select the **AWS Region** from the drop-down list. This is the hosting region for your Amazon Web Services.
      </Step>

      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme** to use when connecting to remote services. Then select the tab for your authentication scheme and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AwsRootKeys">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsEC2Roles">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsIAMRoles">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Role ARN**. This is the Amazon Resource Name of the role to use when authenticating.
          </Step>

          <Step>
            (Optional) Enter the **AWS External Id**. This is a unique identifier that might be required when you assume a role in another account.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsTempCredentials">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to AWS. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Session Token**. See the [AWS Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) for more information about the session token.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsCredentialsFile">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Keycloak">
        <Steps>
          <Step>
            Enter the **Keycloak Realm URL**. This specifies the full URL to the Keycloak server, including the specific realm used for authentication and authorization.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Blob Storage">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2 SSL">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Files">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Box">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Dropbox">
    <Steps>
      <Step>
        (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTP">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTPS">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Google Cloud Storage">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Google Drive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS Secure">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTP">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTPS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="IBM Object Storage Source">
    <Steps>
      <Step>
        Enter the **Api Key** used to identify the user to the IBM Cloud.
      </Step>

      <Step>
        Enter the **Region**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from the security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneDrive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneLake">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Oracle Cloud Storage">
    <Steps>
      <Step>
        Enter the hosting **Region** for your S3-like Web Services.
      </Step>

      <Step>
        Enter the **Oracle Namespace**. This is the Oracle Cloud Object Storage namespace to use.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SFTP">
    <Steps>
      <Step>
        Select the **SSH Auth Mode**, which is the type of authentication to use when connecting to remote services. Then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Password">
        <Steps>
          <Step>
            Enter the **SSH User** used to authenticate to the SFTP server.
          </Step>

          <Step>
            Enter the **SSH Password** used to authenticate to the SFTP server.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Public_Key">
        <Steps>
          <Step>
            Enter the **SSH Client Cert**, which is the name of the certificate store for the client certificate.
          </Step>

          <Step>
            Select the **SSH Client Cert Type**, which is the type of key store containing the client certificate.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Password**. This is the password for the client certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Subject**. This is the subject of the SSH client certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint SOAP">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAS Data Sets, see [this information page](https://cdn.cdata.com/help/LIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAS Xpt
Source: https://docs.cloud.cdata.com/en/Data-Sources/SASXpt



## Setup Guide

Follow these steps to connect SAS Xpt to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAS Xpt* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI** for the SAS resource location.
  </Step>

  <Step>
    Select the **Connection Type**, which specifies the file storage service, server, or file access protocol through which your SAS Xpt files are stored and retrieved.
  </Step>
</Steps>

## Connection Types

<Tabs>
  <Tab title="Amazon S3">
    <Steps>
      <Step>
        Select the **AWS Region** from the drop-down list. This is the hosting region for your Amazon Web Services.
      </Step>

      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme** to use when connecting to remote services. Then select the tab for your authentication scheme and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AwsRootKeys">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsEC2Roles">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsIAMRoles">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Role ARN**. This is the Amazon Resource Name of the role to use when authenticating.
          </Step>

          <Step>
            (Optional) Enter the **AWS External Id**. This is a unique identifier that might be required when you assume a role in another account.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsTempCredentials">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to AWS. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Session Token**. See the [AWS Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) for more information about the session token.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsCredentialsFile">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Keycloak">
        <Steps>
          <Step>
            Enter the **Keycloak Realm URL**. This specifies the full URL to the Keycloak server, including the specific realm used for authentication and authorization.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="EKSPodIdentity">
        <Steps>
          <Step>
            (Optional) Enter the **AWS Container Credentials Full URI**. This is the full URI of the container credential provider endpoint used by EKS Pod Identity.
          </Step>

          <Step>
            (Optional) Enter the **AWS Container Authorization Token File**. This is the path to a file containing the authorization token for the EKS Pod Identity credential provider.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Blob Storage">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2 SSL">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Files">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Box">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Dropbox">
    <Steps>
      <Step>
        (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTP">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTPS">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Google Cloud Storage">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Google Drive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS Secure">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTP">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTPS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="IBM Object Storage Source">
    <Steps>
      <Step>
        Enter the **Api Key** used to identify the user to the IBM Cloud.
      </Step>

      <Step>
        Enter the **Region**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from the security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneDrive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneLake">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Oracle Cloud Storage">
    <Steps>
      <Step>
        Enter the hosting **Region** for your S3-like Web Services.
      </Step>

      <Step>
        Enter the **Oracle Namespace**. This is the Oracle Cloud Object Storage namespace to use.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SFTP">
    <Steps>
      <Step>
        Select the **SSH Auth Mode**, which is the type of authentication to use when connecting to remote services. Then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Password">
        <Steps>
          <Step>
            Enter the **SSH User** used to authenticate to the SFTP server.
          </Step>

          <Step>
            Enter the **SSH Password** used to authenticate to the SFTP server.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Public_Key">
        <Steps>
          <Step>
            Enter the **SSH Client Cert**, which is the name of the certificate store for the client certificate.
          </Step>

          <Step>
            Select the **SSH Client Cert Type**, which is the type of key store containing the client certificate.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Password**. This is the password for the client certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Subject**. This is the subject of the SSH client certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Xpt tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint SOAP">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST V1">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAS Xpt, see [this information page](https://cdn.cdata.com/help/JXM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Salesforce Marketing Cloud
Source: https://docs.cloud.cdata.com/en/Data-Sources/SFMarketingCloud



## Setup Guide

Follow these steps to connect Salesforce Marketing Cloud to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Salesforce Marketing Cloud* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Schema** of either **SOAP** or **REST**.
  </Step>

  <Step>
    Enter a **Subdomain**. Your subdomain is specified in the Authentication Base URL. For example, *[https://SUBDOMAIN.auth.marketingcloudapis.com](https://SUBDOMAIN.auth.marketingcloudapis.com)*.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        To use this data source, you must supply a **Callback URL** when setting up your OAuth app. This is sometimes referred to as a 'Redirect URL'. On Connect AI, this is marked as `https://oauth.cdata.com/oauth/`. Use this when you configure your OAuth app on Salesforce Marketing Cloud.
      </Step>

      <Step>
        Enter the following information:

        * **OAuth Client Id**—assigned when you registered your Salesforce Marketing Cloud account for OAuth.
        * **OAuth Client Secret**—for your Salesforce Marketing Cloud account for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—assigned when you registered your Salesforce Marketing Cloud account for OAuth.
        * **OAuth Client Secret**—for your Salesforce Marketing Cloud account for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic (SOAP schema only)">
    <Steps>
      <Step>
        Enter the **User** and **Password** for Salesforce Marketing Cloud.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Salesforce Marketing Cloud, see [this information page](https://cdn.cdata.com/help/FEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft SQL Server Analysis Services
Source: https://docs.cloud.cdata.com/en/Data-Sources/SSAS



## Setup Guide

Follow these steps to connect Microsoft SQL Server Analysis Services to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft SQL Server Analysis Services* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** used to connect to Microsoft SQL Server Analysis Services.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="NTLM">
    Set to **NTLM** to use your Windows credentials to authenticate.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    Set to **Basic** to use HTTP Basic authentication.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Digest">
    Set to **Digest** to use HTTP Digest authentication.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this authentication method.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    Set to **Negotiate** if you want the provider to negotiate an authentication mechanism with the server.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft SQL Server Analysis Services, see [this information page](https://cdn.cdata.com/help/FYM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Sage 200
Source: https://docs.cloud.cdata.com/en/Data-Sources/Sage200



## Setup Guide

Follow these steps to connect Sage 200 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Sage 200* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Schema** that matches the API you registered for.
  </Step>

  <Step>
    Enter your **Subscription Key**. To get the subscription key, your account must be registered for Sage API access. Use [this link](https://developer.sage.com/200/api/get-started/) to register for access. Once you register for an API, find the subscription key in your Sage 200 profile.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Sage 200, see [this information page](https://cdn.cdata.com/help/GGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Sage 300
Source: https://docs.cloud.cdata.com/en/Data-Sources/Sage300



## Setup Guide

Follow these steps to connect Sage 300 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Sage 300* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of the HTTP or HTTPS endpoint of your Sage 300 system. For example, *[http://localhost/Sage300WebApi/v1.0/-/](http://localhost/Sage300WebApi/v1.0/-/)*.
  </Step>

  <Step>
    Enter the **User**, which is the authenticating user's Id.
  </Step>

  <Step>
    Enter the **Password** for the authenticating user.
  </Step>

  <Step>
    Enter the **Company** that you want to connect to.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Sage 300, see [this information page](https://cdn.cdata.com/help/GTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Sage Business Cloud Accounting
Source: https://docs.cloud.cdata.com/en/Data-Sources/SageBCAccounting



## Setup Guide

Follow these steps to connect Sage Business Cloud Accounting to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Sage Business Cloud Accounting* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Sage Business Cloud Accounting sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Sage Business Cloud Accounting account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Sage Business Cloud Accounting, see [this information page](https://cdn.cdata.com/help/GAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Sage Intacct
Source: https://docs.cloud.cdata.com/en/Data-Sources/SageIntacct



## Setup Guide

Follow these steps to connect Sage Intacct to your Connect AI account:

<Steps>
  <Step>Open the **Sources** page of the Connect AI navigation menu.</Step>
  <Step>Click **+ Add Connection** in the upper-right corner.</Step>

  <Step>
    Type *Sage Intacct* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name
    or keep the default name.
  </Step>

  <Step>
    For the **Schema** field, select either **SageIntacct** or **SageIntacctRest**.
    Then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Schema

<Tabs>
  <Tab title="SageIntacct">
    <Steps>
      <Step>
        Select the Authentication method, then proceed to the relevant tab and
        follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Frame>
          <iframe title="How to Allow Sage Intacct Connection in Connect AI" />
        </Frame>

        If your organization does not use embedded CData credentials, you must first add the CData Sender ID in Sage Intacct:

        <Steps>
          <Step>Log in to Sage Intacct as an administrator.</Step>
          <Step>Navigate to **Company**.</Step>

          <Step>
            Under **Setup** select **Company**.

            <img alt="" />
          </Step>

          <Step>
            Go to the **Security** section and add the CData Sender ID.

            <img alt="" />
          </Step>

          <Step>
            If this does not work, utilize our Sender ID and Sender Password to select
            another user with the right permissions from your Web Services
            authorizations list.

            <img alt="" />
          </Step>
        </Steps>

        If necessary, contact `support@cdata.com` for additional assistance.

        <Steps>
          <Step>
            Enter the following information:

            * **User**—the Sage Intacct username for authentication.
            * **Password**—the user password.
            * **Company ID**—the Company ID. You can find this in Sage Intacct under **Company > Company info**.
          </Step>

          <Step>
            If your organization does not use embedded CData credentials, go to the **Advanced Settings** tab and enter the following:

            * **Sender ID**—the Web Services Sender ID you added above.
            * **Sender Password**—the Web Services password you added above.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OKTA">
        <Steps>
          <Step>
            Enter the following information:

            * **User**—the Okta user account.
            * **Password**—the password associated with the Okta account.
            * **SSO Login URL**—set to the URL used by the SSO provider.
            * **SSO Properties**—add property IntacctUserID, set to the Okta user specified in the User connection property. Then add all desired properties. The following is an example of a valid connection string:

              ```
              AuthScheme=Okta;
              SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';
              User=oktaUserName; Password=oktaPassword;
              SSOProperties='IntacctUserID=intacct\_user';
              ```

              <Note>If you add an APIToken property, it must be set to the API Token that the customer created from the Okta org. It should only be used when authenticating a user via a trusted application or proxy that overrides Okta client request context.</Note>
            * **Company ID**—the Company ID. You can find this in Sage Intacct under **Company > Company info**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Note>The **OAuth Client Id** and **OAuth Client Secret** come from an app registered in the Azure portal. See [Microsoft's documentation](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) for details.</Note>

        <Steps>
          <Step>
            Enter the following information:

            * **User**—the AzureAD user account.
            * **Password**—the password associated with the AzureAD account.
            * **SSO Login URL**—set to the URL used by the SSO provider.
            * **SSO Properties**—add property IntacctUserID, set to the AzureAD user specified in the User connection property. Then add all desired properties.
            * **OAuth Client Id**—the Client Id from your Azure app registration.
            * **OAuth Client Secret**—the Client Secret from your Azure app registration.
            * **Company ID**—the Company ID. You can find this in Sage Intacct under **Company > Company info**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Note>The **OAuth Client Id** and **OAuth Client Secret** come from an app registered in the OneLogin admin console. See [OneLogin's documentation](https://developers.onelogin.com/openid-connect/api/create-session-login-token) for details.</Note>

        <Steps>
          <Step>
            Enter the following information:

            * **User**—the OneLogin user account.
            * **Password**—the password associated with the OneLogin account.
            * **SSO Login URL**—set to the URL used by the SSO provider.
            * **SSO Properties**—add property IntacctUserID, set to the OneLogin user specified in the User connection property. Then add all desired properties.
            * **OAuth Client Id**—the Client Id from your OneLogin app registration.
            * **OAuth Client Secret**—the Client Secret from your OneLogin app registration.
            * **Company ID**—the Company ID. You can find this in Sage Intacct under **Company > Company info**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SageIntacctRest">
    ### Create an OAuth Application

    To create an OAuth application in Sage Intacct, follow these steps:

    <Steps>
      <Step>
        Log in to Sage Intacct as an administrator.
      </Step>

      <Step>
        Navigate to **Company** > **Setup** > **Web Services**.
      </Step>

      <Step>
        Under **OAuth 2.0**, create a new application. Provide a name for the application (for example, *CData Connect AI*).
      </Step>

      <Step>
        In the **Redirect URI** field, enter `https://oauth.cdata.com/oauth/`.
      </Step>

      <Step>
        Set the grant type to **Authorization Code**.
      </Step>

      <Step>
        Save the application. Copy the **Client ID** and **Client Secret**. You need these values in the connection steps below.
      </Step>
    </Steps>

    ### Connect to Sage Intacct

    <Steps>
      <Step>
        Copy the **Callback URL** and confirm it matches the redirect URL registered in your Sage Intacct OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Id** from your Sage Intacct OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** from your Sage Intacct OAuth application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Sage Intacct sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Sage Intacct account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Sage Intacct, see [this information page](https://cdn.cdata.com/help/CTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Salesloft
Source: https://docs.cloud.cdata.com/en/Data-Sources/SalesLoft



## Setup Guide

Follow these steps to connect Salesloft to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Salesloft* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    To use OAuth authentication, register an OAuth application with Salesloft:

    <Steps>
      <Step>
        Log in to your Salesloft Account Portal and go to **Your Applications** > **OAuth Applications**, then click **Create New**.
      </Step>

      <Step>
        Fill in the **Name** and **Description** that users will see when authorizing your app. Optionally upload an application logo.
      </Step>

      <Step>
        Set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Set **Grant Type** to **Authorization Code**.
      </Step>

      <Step>
        Select the **Scopes** your integration requires.
      </Step>

      <Step>
        Click **Submit**, then copy the **Application ID** (Client ID) and **Secret** (Client Secret). Store the secret securely. In Connect AI, the Application ID is entered as the **OAuth Client Id** and the Secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Salesloft.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Salesloft sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Salesloft account and grant the requested permissions.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    OAuthClient uses client credentials for machine-to-machine access without a user sign-in. Register an OAuth application with Salesloft:

    <Steps>
      <Step>
        Log in to your Salesloft Account Portal and go to **Your Applications** > **OAuth Applications**, then click **Create New**.
      </Step>

      <Step>
        Fill in the **Name** and **Description**. Optionally upload an application logo.
      </Step>

      <Step>
        Set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Set **Grant Type** to **Client Credentials**.
      </Step>

      <Step>
        Select the **Scopes** your integration requires.
      </Step>

      <Step>
        Click **Submit**, then copy the **Application ID** (Client ID) and **Secret** (Client Secret). Store the secret securely.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Salesloft.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIKey">
    To use API Key authentication, you must be logged in to an account with Admin privileges:

    <Steps>
      <Step>
        Log in to your Salesloft account and click **Settings** from the main navigation bar.
      </Step>

      <Step>
        Navigate to **Integrations** and select **API** (or click **Your Applications**, depending on your account version).
      </Step>

      <Step>
        Select the **API Keys** tab and click **Create New** (or **New**).
      </Step>

      <Step>
        Enter a descriptive name for the key and select the scopes required for your integration.
      </Step>

      <Step>
        Click **Save** or **Create**, then copy the generated API key immediately and store it securely.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the generated key as the **API Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Salesforce Data 360
Source: https://docs.cloud.cdata.com/en/Data-Sources/SalesforceData360



## Prerequisites

### OAuth, OAuthPKCE, and OAuthJWT

To use OAuth, OAuthPKCE, or OAuthJWT authentication, you must create a Connected App in Salesforce:

<Steps>
  <Step>
    Log in to Salesforce Data 360 and click **Setup**.
  </Step>

  <Step>
    In the **Quick Find** box, search for **App Manager**, then click **New Connected App**.
  </Step>

  <Step>
    Enter a name for your app and your email address. Then select:

    * **Enable OAuth Settings**
    * **Enable Authorization Code and Credentials Flow**
    * **Enable Token Exchange Flow**
  </Step>

  <Step>
    Set the **Callback URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Add the following OAuth scopes:

    * Manage user data via APIs (`api`)
    * Perform requests at any time (`refresh_token`, `offline_access`)
    * Manage Data 360 profile data (`cdp_profile_api`)
    * Perform ANSI SQL queries on Data 360 data (`cdp_query_api`)
    * Manage Data 360 Identity Resolution (`cdp_identityresolution_api`)
    * Manage Data 360 Calculated Insight data (`cdp_calculated_insight_api`)
  </Step>

  <Step>
    Click **Save and Continue**. Make note of the **Consumer Key** and **Consumer Secret**. In Connect AI, these are entered as the **OAuth Client Id** and **OAuth Client Secret**.
  </Step>
</Steps>

### OAuthClient

To use OAuthClient authentication, you must create a Connected App with the client credentials flow enabled:

<Steps>
  <Step>
    Log in to Salesforce Data 360 and click **Setup**.
  </Step>

  <Step>
    In the **Quick Find** box, search for **App Manager**, then click **New Connected App**.
  </Step>

  <Step>
    Enter a name for your app and your email address. Then select:

    * **Enable OAuth Settings**
    * **Enable Client Credentials Flow**
    * **Enable Token Exchange Flow**
  </Step>

  <Step>
    Select an execution user for the flow.
  </Step>

  <Step>
    Add the following OAuth scopes:

    * Manage user data via APIs (`api`)
    * Perform requests at any time (`refresh_token`, `offline_access`)
    * Manage Data 360 profile data (`cdp_profile_api`)
    * Perform ANSI SQL queries on Data 360 data (`cdp_query_api`)
    * Manage Data 360 Identity Resolution (`cdp_identityresolution_api`)
    * Manage Data 360 Calculated Insight data (`cdp_calculated_insight_api`)
    * Manage user data via Web browsers (`web`)
  </Step>

  <Step>
    Click **Save and Continue**.
  </Step>

  <Step>
    From the connected app detail page, click **Manage**, then click **Edit Policies**.
  </Step>

  <Step>
    Under **Client Credentials Flow**, click the search icon next to **Run As** and select the execution user. For Enterprise Edition orgs, select a user with the **API Only User** permission.
  </Step>

  <Step>
    Save your changes. Make note of the **Consumer Key** and **Consumer Secret**. In Connect AI, these are entered as the **OAuth Client Id** and **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Salesforce Data 360 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Salesforce Data 360* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) Enter the **Salesforce Access Token** that is used for authentication in the Salesforce instance.
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from your Salesforce Connected App.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Salesforce sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Salesforce account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from your Salesforce Connected App.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Salesforce sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Salesforce account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    Use this method for service-to-service connections that authenticate without an interactive browser sign-in.

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from your Salesforce Connected App.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Warning>
      OAuthPassword is deprecated. Use OAuthJWT or OAuthPKCE instead. The **Security Token** property is also deprecated and applies only to this scheme.
    </Warning>

    <Steps>
      <Step>
        Enter your Salesforce **User** and **Password**.
      </Step>

      <Step>
        (Optional) Enter a **Security Token**. This is required unless your IP address has been added to Trusted IP Addresses in Salesforce.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth JWT Cert**–the content of the certificate in PEM format.
        * **OAuth JWT Cert Type**–the type of key store containing the certificate. The default cert type is **PEMKEY\_BLOB**.
        * **OAuth JWT Issuer**–The issuer of the Java Web Token.
        * **OAuth JWT Cert Password**–(optional) required only if the certificate is encrypted.
        * **OAuth JWT Cert Subject**–(optional) identifies the certificate subject in the store.
        * **OAuth JWT Subject**–(optional) the user subject for delegated access.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Salesforce Pardot
Source: https://docs.cloud.cdata.com/en/Data-Sources/SalesforcePardot



## Setup Guide

Follow these steps to connect Salesforce Pardot to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Salesforce Pardot* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    On a separate browser tab, log in to your Salesforce account. Open the **Setup** page, expand the **Pardot** section, and click **Pardot Account Setup**.
  </Step>

  <Step>
    Copy the business unit Id for the business unit that you want to connect.
  </Step>

  <Step>
    Return to Connect AI and enter the copied value into the **Business Unit ID** field.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Select your schema version.
      </Step>

      <Step>
        If you are using a demo account, set **Is Demo Account** to True. Otherwise, leave it false.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Salesforce Pardot sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Salesforce Pardot account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth Password">
    <Steps>
      <Step>
        Enter the Salesforce Pardot username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        Select your schema version.
      </Step>

      <Step>
        If you are using a demo account, set **Is Demo Account** to True. Otherwise, leave it false.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth JWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT certificate**. This is multi-line and in PEM format.
      </Step>

      <Step>
        Select the **OAuth JWT Certification type**.
      </Step>

      <Step>
        Enter the **OAuth JWT Issuer**. This must include the client\_id or connected app for the which the certificate is registered.
      </Step>

      <Step>
        (Optional) Enter a **OAuth JWT Cert Password** if the certificate. This only needs to be done if the certificate is encrypted.
      </Step>

      <Step>
        (Optional) If required, add an **OAuth JWT Cert Subject**.
      </Step>

      <Step>
        (Optional) If necessary, enter a **OAuth JWT Subject**, formatted as an email.
      </Step>

      <Step>
        Select your schema version.
      </Step>

      <Step>
        If you are using a demo account, set **Is Demo Account** to True. Otherwise, leave it false.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Salesforce Pardot, see [this information page](https://cdn.cdata.com/help/GPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Sansan
Source: https://docs.cloud.cdata.com/en/Data-Sources/Sansan



## Setup Guide

Follow these steps to connect Sansan to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Sansan* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** from Sansan.
  </Step>

  <Step>
    (Optional) You only need to click the **Include Past Bizcards** slider if you also want to see previous versions of business cards.
  </Step>

  <Step>
    (Optional) Use the **Range** field to determine which business cards to show. For example, to show only your own business cards, enter `SELECT * FROM Tags WHERE Range='me'`.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Sansan, see [this information page](https://cdn.cdata.com/help/USM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# QuickBooks Time
Source: https://docs.cloud.cdata.com/en/Data-Sources/TSheets



## Prerequisites

Before you can connect to Connect AI, you must create OAuth client credentials in QuickBooks Time.

<Steps>
  <Step>
    Log in to QuickBooks Time.
  </Step>

  <Step>
    At the left navigation pane, select **Feature Add-ons** > **Manage Add-ons**.
  </Step>

  <Step>
    Select **API Add-On**.
  </Step>

  <Step>
    Click **Install**.
  </Step>

  <Step>
    Select **Add a new application** at bottom left. If a followup window does not display, return to the left navigation pane's **Feature Add-ons** area and select **API**.
  </Step>

  <Step>
    Enter a short name and a meaningful description for the new application.
  </Step>

  <Step>
    Set the **Redirect URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*. This is also called the **Callback URL**.
  </Step>

  <Step>
    Click **Save**. The admin tool generates the OAuth Client Id and OAuth Client Secret that you enter below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect QuickBooks Time to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *QuickBooks Time* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** that you obtained in the prerequisites.
  </Step>

  <Step>
    Enter the **OAuth Client Secret** that you obtained in the prerequisites.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the QuickBooks Time sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your QuickBooks Time account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and QuickBooks Time, see [this information page](https://cdn.cdata.com/help/HCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# AI Tools
Source: https://docs.cloud.cdata.com/en/Clients/AITools

Below is a list of the Artificial Intelligence (AI) tools that connect to Connect AI:

* [Agent Bricks](/en/Clients/AgentBricks-Client)
* [Amazon Quick](/en/Clients/AmazonQuick-Client)
* [ChatGPT](/en/Clients/ChatGPT-Client)
* [Claude](/en/Clients/Claude-Client)
* [Claude Code](/en/Clients/ClaudeCode-Client)
* [Codex](/en/Clients/Codex-Client)
* [CrewAI](/en/Clients/CrewAI-Client)
* [Cursor](/en/Clients/Cursor-Client)
* [Gemini](/en/Clients/Gemini-Client)
* [Gemini Enterprise](/en/Clients/GeminiEnterprise-Client)
* [GitHub Copilot](/en/Clients/GitHubCopilot-Client)
* [Grok](/en/Clients/Grok-Client)
* [LangChain](/en/Clients/LangChain-Client)
* [LangGraph](/en/Clients/LangGraph-Client)
* [LlamaIndex](/en/Clients/LlamaIndex-Client)
* [Lovable](/en/Clients/Lovable-Client)
* [Microsoft Copilot Studio](/en/Clients/MicrosoftCopilot-Client)
* [Microsoft Foundry](/en/Clients/MicrosoftFoundry-Client)
* [Mistral Le Chat](/en/Clients/Mistral-Client)
* [n8n](/en/Clients/N8N-Client)
* [Replit Agent](/en/Clients/Replit-Client)
* [Windsurf](/en/Clients/Windsurf-Client)


# Agent Bricks
Source: https://docs.cloud.cdata.com/en/Clients/AgentBricks-Client

The Connect AI Remote MCP Service enables Agent Bricks to securely read and take action on your data in real time.

## Prerequisites

Before you can configure and use Agent Bricks with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Create an OAuth App in CData Connect AI

Agent Bricks uses OAuth 2.0 to authenticate users against the CData Connect AI MCP Server. This requires an OAuth App in your CData Connect AI account.

The OAuth App requires a callback URL, which you build from your Databricks workspace host. The steps below walk you through constructing this URL and entering it as you create the app.

<Steps>
  <Step>
    Click the gear icon in the top-right corner of Connect AI to open **Settings**.
  </Step>

  <Step>
    Navigate to **OAuth Apps** and click **+ Create App**. The **Create OAuth App** dialog appears.
  </Step>

  <Step>
    Enter the following settings:

    * **Name**–enter a descriptive name (for example, *AgentBricksOAuth*).
    * **Application Type**–select **Web Application**.
    * **Callback URL**–follow the instructions below to create a callback URL.

    <Steps>
      <Step>
        Open your Databricks workspace in a browser and copy the host from the address bar, everything between `https://` and the next `/`. For example: `adb-5555555555555555.5.azuredatabricks.net`. (AWS workspaces look like `dbc-xxxxxxxx-xxxx.cloud.databricks.com`; GCP like `xxxx.gcp.databricks.com`.)
      </Step>

      <Step>
        Append `/login/oauth/http.html` to that host. Using the example above, you would enter the following as the **Callback URL**: *[https://adb-5555555555555555.5.azuredatabricks.net/login/oauth/http.html](https://adb-5555555555555555.5.azuredatabricks.net/login/oauth/http.html)*.
      </Step>

      <Step>
        Paste this value into the **Callback URL** field of your Connect AI OAuth app.

        <Frame>
          <img alt="Creating an OAuth App in CData Connect AI" />
        </Frame>
      </Step>
    </Steps>
  </Step>

  <Step>
    Click **Confirm**. CData Connect AI creates the OAuth app and generates a **Client ID** and **Client Secret** for the client application.

    <Frame>
      <img alt="OAuth App Client Id and Client Secret" />
    </Frame>
  </Step>

  <Step>
    Copy both the **Client ID** and **Client Secret**. You will need them in the next section.
  </Step>
</Steps>

## Create an MCP Server Connection in Databricks

<Steps>
  <Step>
    Log in to Databricks and go to **Databricks Marketplace**.
  </Step>

  <Step>
    In the search bar, enter *Connect AI*. Click **CData Connect AI: Managed MCP Platform for Enterprise Databricks Agents**.

    <Frame>
      <img alt="Install MCP platform" />
    </Frame>
  </Step>

  <Step>
    Click **Install**. A dialog appears:

    <Frame>
      <img alt="Install MCP platform dialog" />
    </Frame>
  </Step>

  <Step>
    Enter the **Connection name** for the app, such as **QueryMCP**.
  </Step>

  <Step>
    **Host** and **Base path** are pre-filled.
  </Step>

  <Step>
    Enter the **Client ID** and **Client Secret** you copied from the OAuth App you created in the previous section.
  </Step>

  <Step>
    Select the checkbox to accept the terms and conditions, then click **Install**.
  </Step>
</Steps>

## Create an Agent in Databricks

<Steps>
  <Step>
    In the **Agents** tab, click **Create Agent**.
  </Step>

  <Step>
    Select **Supervisor Agent**.
  </Step>

  <Step>
    In the **Create Supervisor Agent** dialog, enter the following:

    * **Name**–enter a name for your agent.
    * **Description**–enter a description of the agent.
    * **Configure Agents**:
      * **Type**–select **External MCP Server**.
      * **Unity Catalog connection**–select the MCP connection you made in the previous step.
      * **Describe the content**–enter a description of what the MCP connection is.

    <Frame>
      <img alt="Create agent" />
    </Frame>
  </Step>

  <Step>
    Click **Create Agent**.
  </Step>
</Steps>

## Test your Agent

<Steps>
  <Step>
    On your agent’s page, click **Open in Playground**.

    <Frame>
      <img alt="Open in playground" />
    </Frame>
  </Step>

  <Step>
    You can now query your connected data with the Connect AI MCP Server through the Supervisor Agent.

    <Frame>
      <img alt="Agent playground" />
    </Frame>
  </Step>
</Steps>


# Amazon Quick
Source: https://docs.cloud.cdata.com/en/Clients/AmazonQuick-Client

This page outlines the steps to connect Amazon Quick to your Connect AI account.

Amazon Quick lets you build and share AI agents that act on your data. This page explains how to connect Connect AI to Amazon Quick as a Model Context Protocol (MCP) connector, enabling your agents to query and take action on live data.

## Prerequisites

Before you can configure and use Amazon Quick with Connect AI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Have access to Amazon Quick and an IAM user with permission to create and publish connectors for your team.

## Create an MCP Connector in Amazon Quick

Begin creating the connector in Amazon Quick. During setup, Amazon Quick displays the redirect URL that you need to create the OAuth App in Connect AI.

<Steps>
  <Step>
    Log in to Amazon Quick with your IAM user.
  </Step>

  <Step>
    Click **Connectors**, and then click **Create for your team**.

    <Frame>
      <img alt="Create a connector for your team" />
    </Frame>
  </Step>

  <Step>
    Choose **Model Context Protocol**.
  </Step>

  <Step>
    Create a new MCP connector by providing the **MCP URL** *[https://mcp.cloud.cdata.com/mcp](https://mcp.cloud.cdata.com/mcp)*. You can also use a toolkit URL to scope the connector to a specific toolkit.

    <Frame>
      <img alt="Enter the MCP URL" />
    </Frame>
  </Step>

  <Step>
    Click **Next**.
  </Step>

  <Step>
    Select **Custom user-based OAuth App**.

    <Frame>
      <img alt="Select custom OAuth" />
    </Frame>
  </Step>

  <Step>
    Copy the **redirect URL** that Amazon Quick displays. It follows this format:

    ```
    https://{region}.quicksight.aws.amazon.com/sn/oauthcallback
    ```

    You will enter this URL when you create the OAuth App in the next section. Leave this screen open, because you will return to it to enter your Client ID and Client Secret.
  </Step>
</Steps>

## Create an OAuth App in Connect AI

Amazon Quick uses OAuth 2.0 to authenticate users against the Connect AI MCP Server. This requires a user-based OAuth application in your Connect AI account.

<Steps>
  <Step>
    Click the gear icon in the top-right corner of Connect AI to open **Settings**.
  </Step>

  <Step>
    Navigate to the **OAuth Apps** tab and click **+ Create App**. The **Create OAuth App** dialog appears.
  </Step>

  <Step>
    Enter the following settings:

    * **Name**–enter a descriptive name (for example, *AmazonQuickOAuth*).
    * **Application Type**–select **Web Application**.
    * **Callback URL**–enter the redirect URL you copied from Amazon Quick (for example, *[https://us-east-1.quicksight.aws.amazon.com/sn/oauthcallback](https://us-east-1.quicksight.aws.amazon.com/sn/oauthcallback)*).

    <Frame>
      <img alt="Creating an OAuth App in Connect AI" />
    </Frame>
  </Step>

  <Step>
    Click **Confirm**. Connect AI generates a **Client ID** and **Client Secret**.

    <Frame>
      <img alt="Client ID and Client Secret" />
    </Frame>
  </Step>

  <Step>
    Copy both the **Client ID** and **Client Secret**. You will need them in the next section.
  </Step>
</Steps>

## Complete the Connector in Amazon Quick

<Steps>
  <Step>
    Return to the Amazon Quick connector setup and enter the following settings:

    * **Client ID** and **Client Secret**–from the OAuth application created above.
    * **Token URL**–enter *[https://cloud-login.cdata.com/oauth/token](https://cloud-login.cdata.com/oauth/token)*.
    * **Authorization URL**–enter *[https://cloud-login.cdata.com/authorize](https://cloud-login.cdata.com/authorize)*.

    <Frame>
      <img alt="Create MCP integration" />
    </Frame>
  </Step>

  <Step>
    Click **Create and Continue**. You are prompted with a login screen. Complete the sign-in.
  </Step>

  <Step>
    Publish the connector.
  </Step>
</Steps>

## Use the Connector in an Agent

After you publish the connector, you can add it to any Amazon Quick agent and call its tools to query.

<Frame>
  <img alt="Enabled actions" />
</Frame>

Test the connector by asking it a question:

<Frame>
  <img alt="Sample query" />
</Frame>


# ChatGPT
Source: https://docs.cloud.cdata.com/en/Clients/ChatGPT-Client



## Prerequisites

Before you can configure and use ChatGPT with Connect AI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Have a [ChatGPT](https://chatgpt.com) Plus or Pro subscription.

## Connect to Connect AI

Follow these steps to add a Connect AI connector in ChatGPT:

<Steps>
  <Step>
    Sign in to [ChatGPT](https://chatgpt.com) with a Plus or Pro subscription.
  </Step>

  <Step>
    Navigate to **Apps** from the left panel.
  </Step>

  <Step>
    Search for *CData Connect AI* and select it from the results.

    <Frame>
      <img alt="CData Connect AI in ChatGPT Apps" />
    </Frame>
  </Step>

  <Step>
    Click **Connect** to authenticate to your Connect AI account.

    <Frame>
      <img alt="Connect to CData Connect AI" />
    </Frame>
  </Step>

  <Step>
    Click **Sign in with CData Connect AI** and complete the sign-in.

    <Frame>
      <img alt="Sign in with CData Connect AI" />
    </Frame>
  </Step>

  <Step>
    After successful authorization, click **Start chat**.

    <Frame>
      <img alt="Start chat with CData Connect AI" />
    </Frame>
  </Step>

  <Step>
    CData Connect AI should be automatically enabled in the chat. If not, click **+**, select **More**, and then select **CData Connect AI** from the drop-down list.

    <Frame>
      <img alt="Enable CData Connect AI in the chat" />
    </Frame>
  </Step>

  <Step>
    You can now start exploring your data with natural language prompts. ChatGPT uses the Connect AI MCP server to query your live data and may ask your permission before accessing it.

    Refer to CData's [prompt library](https://www.cdata.com/ai/prompt-library/) for prompt ideas.
  </Step>
</Steps>

<Note>
  ChatGPT's Apps feature is currently in beta and its setup process is subject to change. Refer to [ChatGPT's documentation](https://help.openai.com/en/articles/11487775-apps-in-chatgpt) for the latest setup information.
</Note>


# Claude
Source: https://docs.cloud.cdata.com/en/Clients/Claude-Client



## Prerequisites

Before you can use Claude with Connect AI, you must first connect at least one data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Connect to Connect AI

Follow these steps to add a Connect AI connector in Claude:

<Steps>
  <Step>
    Sign in to [https://claude.ai](https://claude.ai) or create a new account.
  </Step>

  <Step>
    Expand the left navigation menu.
  </Step>

  <Step>
    In the bottom-left corner, click your user name and select **Settings** from the menu. The **Settings** screen appears.
  </Step>

  <Step>
    In the **Settings** screen, click **Connectors**.
  </Step>

  <Step>
    In the top-right corner, click **Browse connectors**.
  </Step>

  <Step>
    Search for *CData Connect AI*.

    <Frame>
      <img alt="Claude Connect AI Connector" />
    </Frame>
  </Step>

  <Step>
    Click **CData Connect AI**.
  </Step>

  <Step>
    In the CData Connect AI connector, click **Connect**. Grant access to the connector.
  </Step>

  <Step>
    Click **Configure** if you want to customize the permissions on the connector.
  </Step>

  <Step>
    Review the provided tools to configure whether you want to **Always allow**, **Needs approval**, or **Block** specific tools made available by the MCP server.

    <Frame>
      <img alt="Connect AI MCP Tools" />
    </Frame>
  </Step>

  <Step>
    In the left navigation menu, click **New chat**.
  </Step>

  <Step>
    You can now start exploring your data with natural language prompts. Claude outlines the steps it uses to retrieve data from the source in Connect AI, using Connect AI's built-in tools. Depending on your tool settings when you configured the connector, Claude asks your permission before using the Connect AI built-in tools.

    Refer to CData's [prompt library](https://www.cdata.com/solutions/mcp/prompt-library/) for prompt ideas.
  </Step>
</Steps>

<Note>
  Claude's setup process is subject to change. Refer to [Claude's documentation](https://support.anthropic.com/en/articles/11175166-getting-started-with-custom-connectors-using-remote-mcp) for the latest setup information.
</Note>


# Claude Code
Source: https://docs.cloud.cdata.com/en/Clients/ClaudeCode-Client

Claude Code is Anthropic’s agentic coding tool that reads your codebase, edits files, and runs commands from your terminal, IDE, desktop app, and browser. This page explains how to connect Claude Code to the Connect AI MCP server.

Connect AI uses OAuth authentication by default, but you can also use Basic authentication with a Personal Access Token (PAT).

## Prerequisites

Before you can configure and use Claude Code with Connect AI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

* (Basic authentication only) Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Install Claude Code

<Steps>
  <Step>
    Open PowerShell as an Administrator and run the following command:

    ```bash theme={null}
    npm install -g @anthropic-ai/claude-code
    ```
  </Step>

  <Step>
    Once the installation is done, try running: `npm list -g @anthropic-ai/claude-code` in your terminal to confirm the installation. You should see something like this:

    ```bash theme={null}
    C:\Users\ConnectAIUser\AppData\Roaming\npm
    -- @anthropic-ai/claude-code@2.0.28
    ```
  </Step>

  <Step>
    Create a project named `Claude Code` and open it in Visual Studio Code.
  </Step>
</Steps>

## Connect to Connect AI

### OAuth Authentication

In the terminal of your project, run the following command:

```bash wrap theme={null}
claude mcp add --transport http connectmcp https://mcp.cloud.cdata.com/mcp
```

This creates a JSON file with your MCP Server.

Adding the server registers it but does not authenticate it. You complete the OAuth sign-in from inside a Claude Code session:

<Steps>
  <Step>
    Start a session by typing `claude`, then run the `/mcp` command.
  </Step>

  <Step>
    Select the `connectmcp` server, then choose **Authenticate**. Claude Code opens your browser to the Connect AI sign-in page.
  </Step>

  <Step>
    Complete the sign-in. When you return to the terminal, the server status changes to connected.
  </Step>
</Steps>

### Basic Authentication

In the terminal of your project, run the following command:

```bash wrap theme={null}
claude mcp add --transport http connectmcp https://mcp.cloud.cdata.com/mcp --header "Authorization: Basic <Your_Base64Encoded_EMAIL:PAT>"
```

This creates a JSON file with your MCP Server.

## Start a Claude Code Session

<Steps>
  <Step>
    Type `claude`. A welcome screen appears:

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Choose a text style and login method. Claude Code opens the browser to log in to Claude.
  </Step>

  <Step>
    You can now interact with the MCP server:

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# Codex
Source: https://docs.cloud.cdata.com/en/Clients/Codex-Client

Codex is OpenAI's AI coding agent. This page explains how to connect Codex to the Connect AI MCP server.

Connect AI uses OAuth authentication by default, but you can also use Basic authentication with a Personal Access Token (PAT).

## Prerequisites

Before you can configure and use Codex with Connect AI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Install [Node.js](https://nodejs.org) 18 or later.
* Have a ChatGPT plan that includes Codex (Plus, Pro, Business, Edu, or Enterprise), or an OpenAI API key.
* (Basic authentication only) Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

### OAuth Authentication

<Steps>
  <Step>
    Install the Codex CLI globally:

    ```bash theme={null}
    npm install -g @openai/codex
    ```
  </Step>

  <Step>
    Start Codex and sign in:

    ```bash theme={null}
    codex
    ```

    The first time you run Codex, select **Sign in with ChatGPT** and complete the authentication in your browser. To use an API key instead, set the `OPENAI_API_KEY` environment variable.
  </Step>

  <Step>
    Register the Connect AI MCP server. Open your Codex configuration file at `~/.codex/config.toml` and add the following:

    ```toml theme={null}
    [mcp_servers.connectai]
    url = "https://mcp.cloud.cdata.com/mcp"
    startup_timeout_sec = 30
    ```
  </Step>

  <Step>
    Authenticate to the Connect AI MCP server:

    ```bash theme={null}
    codex mcp login connectai
    ```

    Complete the OAuth flow in your browser. Signing in with ChatGPT authenticates you to Codex, but you must run this command separately to authenticate to the Connect AI MCP server. Once you have authenticated, the message `Successfully logged in to MCP server 'connectai'` appears.
  </Step>

  <Step>
    Confirm that Codex registered the server:

    ```bash theme={null}
    codex mcp list
    ```
  </Step>
</Steps>

### Basic Authentication

<Steps>
  <Step>
    Install the Codex CLI globally:

    ```bash theme={null}
    npm install -g @openai/codex
    ```
  </Step>

  <Step>
    Start Codex and sign in:

    ```bash theme={null}
    codex
    ```

    The first time you run Codex, select **Sign in with ChatGPT** and complete the authentication in your browser. To use an API key instead, set the `OPENAI_API_KEY` environment variable.
  </Step>

  <Step>
    Register the Connect AI MCP server. Open your Codex configuration file at `~/.codex/config.toml` and add the following:

    ```toml theme={null}
    [mcp_servers.connectai]
    url = "https://mcp.cloud.cdata.com/mcp"
    http_headers = { "Authorization" = "Basic <Your_Base64Encoded_EMAIL:PAT>" }
    startup_timeout_sec = 30
    ```

    Replace `<Your_Base64Encoded_EMAIL:PAT>` with the Base64-encoded value of your Connect AI email and PAT, in the format `email:PAT`.
  </Step>

  <Step>
    Confirm that Codex registered the server:

    ```bash theme={null}
    codex mcp list
    ```
  </Step>
</Steps>

## Start a Codex Session

Start a Codex session and explore your data with natural language prompts. Codex uses the Connect AI MCP server to query your live data.

<Frame>
  <img alt="" />
</Frame>

Refer to CData's [prompt library](https://www.cdata.com/ai/prompt-library/) for prompt ideas.

<Note>
  If Codex reports that MCP startup is incomplete, the server did not initialize within Codex's default 10-second startup window. Increase `startup_timeout_sec` in the server configuration (for example, to `30` or higher), then start Codex again. First-time connections and OAuth flows often need the extra time.
</Note>

<Note>
  Codex's MCP support and setup process are subject to change. Refer to OpenAI's [Codex MCP documentation](https://developers.openai.com/codex/mcp) for the latest setup information.
</Note>


# CrewAI
Source: https://docs.cloud.cdata.com/en/Clients/CrewAI-Client

CrewAI is an open-source Python framework for building multi-agent systems. This page explains how to create a CrewAI agent to connect to the Connect AI MCP server.

## Prerequisites

Before you can configure and use CrewAI with Connect AI, you must do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.
* Obtain an OpenAI API key at: [https://platform.openai.com](https://platform.openai.com).
* Make sure you have Python >= 3.10 in order to use the CrewAI tools.

## Configure the Connect AI MCP Server

<Steps>
  <Step>
    Create a folder named `cdata-mcp-crew-agent`.
  </Step>

  <Step>
    Create a file with the extension `.env` in the `cdata-mcp-crew-agent` folder.
  </Step>

  <Step>
    Copy and paste the content below. Replace `"CONNECT_AI_EMAIL"` with your Connect AI username and replace `"CONNECT_AI_PAT"` with your PAT obtained in the prerequisites. Your OpenAI API key can be found at [https://platform.openai.com/](https://platform.openai.com/).

    ```bash theme={null}
    # CData MCP Server Configuration
    MCP_SERVER_URL="https://mcp.cloud.cdata.com/mcp"
    MCP_USERNAME="CONNECT_AI_EMAIL"
    MCP_PASSWORD="CONNECT_AI_PAT"
    OPENAI_API_KEY="OPEN_API_KEY"  # Your OPEN AI API Key
    ```
  </Step>
</Steps>

## Install the CrewAI Libraries

Run `pip install crewai requests python-dotenv` in your terminal.

## Create and Run the CrewAI Agent

<Steps>
  <Step>
    Create a file called `crew-agent.py`. This is the CrewAI agent.
  </Step>

  <Step>
    Copy and paste the following, defining the agent's tasks as desired:

    ```python expandable theme={null}
    import os
    import base64
    import requests
    from dotenv import load_dotenv
    from crewai import Agent, Task, Crew
    # Load environment variables
    load_dotenv()
    # MCP Server configuration
    MCP_SERVER_URL = os.getenv('MCP_SERVER_URL', 'https://mcp.cloud.cdata.com/mcp')
    MCP_USERNAME = os.getenv('MCP_USERNAME', '')
    MCP_PASSWORD = os.getenv('MCP_PASSWORD', '')
    # Create Basic Auth header
    auth_header = {}
    if MCP_USERNAME and MCP_PASSWORD:
        credentials = f"{MCP_USERNAME}:{MCP_PASSWORD}"
        auth_header = {
            "Authorization": f"Basic {base64.b64encode(credentials.encode()).decode()}"
        }
    # MCP tool invocation function
    def call_mcp_tool(tool_name, input_data):
        payload = {
            "tool": tool_name,
            "input": input_data
        }
        try:
            response = requests.post(
                MCP_SERVER_URL,
                json=payload,
                headers=auth_header,
                timeout=10
            )
            response.raise_for_status()
            return response.json()
        except Exception as e:
            return {"error": str(e)}
    # Define CrewAI agent
    class MCPQueryAgent(Agent):
        def __init__(self):
            super().__init__(
                name="cdata_query_assistant",
                role="Data Query Assistant",
                goal="Help users explore and query Connect AI databases",
                backstory="You are a helpful assistant trained to interact with Connect AI via MCP tools. You understand databases, schemas, and SQL queries, and you guide users through their data exploration journey."
            )
        def get_catalogs(self):
            return call_mcp_tool("getCatalogs", {})
        def get_schemas(self, catalog):
            return call_mcp_tool("getSchemas", {"catalog": catalog})
        def get_tables(self, catalog, schema):
            return call_mcp_tool("getTables", {"catalog": catalog, "schema": schema})
        def get_columns(self, catalog, schema, table):
            return call_mcp_tool("getColumns", {
                "catalog": catalog,
                "schema": schema,
                "table": table
            })
        def query_data(self, catalog, query):
            return call_mcp_tool("queryData", {
                "catalog": catalog,
                "query": query
            })
    # Instantiate agent
    agent = MCPQueryAgent()
    # Define tasks
    task1 = Task(
        agent=agent,
        description="List the top 10 available catalogs in Connect AI",
        expected_output="Catalog list",
        output_function=lambda agent: agent.get_catalogs()
    )
    # Create and run crew
    crew = Crew(
        agents=[agent],
        tasks=[task1]
    )
    if __name__ == "__main__":
        results = crew.kickoff()
        print("\n=== Final Output ===")
        for result in results:
            print(result)
    ```
  </Step>

  <Step>
    Run `python crew-agent.py` in the terminal. The output displays the results of the task:

    <Frame>
      <img alt="CrewAI Output" />
    </Frame>
  </Step>
</Steps>


# Cursor
Source: https://docs.cloud.cdata.com/en/Clients/Cursor-Client

Cursor is an AI-powered integrated development environment (IDE) developed by Anysphere. It is a fork of Visual Studio Code.

Connect AI uses OAuth authentication by default, but you can also use Basic authentication with a Personal Access Token (PAT).

## Prerequisites

Before you can configure and use Cursor with Connect AI, you must first do the following:

* Install the Cursor IDE.

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

* (Basic authentication only) Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

* (Basic authentication only) Base64-encode your Connect AI credentials in the following format: `Base64("email:PAT")`.

## Connect to Connect AI

### OAuth Authentication

<Steps>
  <Step>
    In the Cursor IDE, go to **Cursor Settings**. Then click **Tools & MCP**, and then click **New MCP Server.** The file `mcp.json` opens automatically in the Cursor IDE.
  </Step>

  <Step>
    Copy and paste the following into the `mcp.json` file.

    ```json theme={null}
    {
      "mcpServers": {
        "cdata-mcp": {
          "url": "https://mcp.cloud.cdata.com/mcp"
        }
      }
    }
    ```
  </Step>

  <Step>
    Return to **Tools & MCP** under **Cursor Settings**. Cursor detects that the server requires OAuth and prompts you to log in. Cursor opens your browser to the Connect AI sign-in page. Complete the sign-in to authorize the connection.
  </Step>

  <Step>
    Confirm that Cursor is connected to CData's MCP Server. You should see **cdata-mcp** listed with a green indicator.

    <Frame>
      <img alt="Cursor start MCP server" />
    </Frame>
  </Step>
</Steps>

### Basic Authentication

<Steps>
  <Step>
    In the Cursor IDE, go to **Cursor Settings**. Then click **Tools & MCP**, and then click **New MCP Server.** The file `mcp.json` opens automatically in the Cursor IDE.
  </Step>

  <Step>
    Copy and paste the following into the `mcp.json` file. Replace the authorization header with the Base64-encoded credentials obtained in the prerequisites.

    ```json theme={null}
    {
      "mcpServers": {
        "cdata-mcp": {
          "url": "https://mcp.cloud.cdata.com/mcp",
          "headers": {
            "Authorization": "Basic YOUR_BASE64_ENCODED_EMAIL:PAT" //Authorization obtained in prerequisites
          }
        }
      }
    }
    ```
  </Step>

  <Step>
    Return to **Tools & MCP** under **Cursor Settings**. Confirm that Cursor is connected to CData's MCP Server. You should see **cdata-mcp** listed with a green indicator.

    <Frame>
      <img alt="Cursor start MCP server" />
    </Frame>
  </Step>
</Steps>

## Chat with Cursor

You can now chat with the assistant. Cursor lists the available tools, the connections, and a result set of a given table of a given connection. By default, Cursor asks for confirmation before executing MCP tool actions.

<Frame>
  <img alt="Cursor sample chat" />
</Frame>


# Gemini
Source: https://docs.cloud.cdata.com/en/Clients/Gemini-Client

Gemini is Google’s family of large language models (LLMs). It can generate text, images, audio, video, and code. This page explains how to connect the Connect AI MCP to Gemini through either the command-line interface or the Google Agent Development Kit (ADK).

Connect AI uses OAuth authentication by default, but you can also use Basic authentication with a Personal Access Token (PAT).

## Prerequisites

Before you can configure and use Gemini with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

(Basic authentication and Google ADK only) Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

You need Python >= 3.10 to use the Gemini tools.

## Connect through the Gemini Command Line Interface

After you install Gemini, create the settings file and then choose an authentication method.

<Steps>
  <Step>
    Go to your user directory `%USERPROFILE%` and create a `.gemini` folder.
  </Step>

  <Step>
    Within the folder, create a file named `settings.json`.
  </Step>
</Steps>

### OAuth Authentication

<Steps>
  <Step>
    Copy and paste the following into the `settings.json` file:

    ```json theme={null}
    {
    "mcpServers": {
       "connect-ai": {
          "httpUrl": "https://mcp.cloud.cdata.com/mcp",
          "trust": true
       }
     },
    "selectedAuthType": "oauth-personal"
    }
    ```
  </Step>

  <Step>
    In the terminal, type `gemini`. You may need to give Google authorization to access your account.
  </Step>

  <Step>
    Run `/mcp auth connect-ai` to authenticate to the Connect AI MCP server. Gemini opens your browser to the Connect AI sign-in page. Complete the sign-in to authorize the connection.
  </Step>
</Steps>

### Basic Authentication

<Steps>
  <Step>
    Copy and paste the following into the `settings.json` file. Replace `EMAIL` with your Connect AI email and `PAT` with the PAT you obtained in the prerequisites:

    ```json theme={null}
    {
    "mcpServers": {
       "connect-ai": {
          "httpUrl": "https://mcp.cloud.cdata.com/mcp",
          "headers": {
            "Authorization": "Basic EMAIL:PAT"  //Replace with your authorization header
         },
          "trust": true
       }
     },
    "selectedAuthType": "oauth-personal"
    }
    ```
  </Step>

  <Step>
    In the terminal, type `gemini`. You may need to give Google authorization to access your account.
  </Step>
</Steps>

## Use Gemini

<Steps>
  <Step>
    The Gemini screen appears as follows:

    <Frame>
      <img alt="Gemini Home Screen" />
    </Frame>
  </Step>

  <Step>
    Enter a prompt in the prompt box to ask Gemini a question. Gemini uses the Connect AI tools such as `getCatalogs`, `getSchemas`, and `getTables` to retrieve data from connected data sources.
  </Step>

  <Step>
    Gemini returns a response to your prompt.

    <Frame>
      <img alt="Gemini Prompt" />
    </Frame>
  </Step>
</Steps>

## Connect through the Google ADK

<Steps>
  <Step>
    Download the folder [adk-mcp-client](https://github.com/CDataSoftware/adk-mcp-client) and unzip the folder.
  </Step>

  <Step>
    Rename `.env example` to `.env`.
  </Step>

  <Step>
    In the `.env` file, replace `your_email@example.com` with your Connect AI email, and replace `your_mcp_password_here` with the PAT created in the prerequisites.
  </Step>

  <Step>
    Run `pip install -r requirements.txt` in your terminal.
  </Step>

  <Step>
    Run `python -m google.adk.cli web --port 5000`. This starts the ADK at port 5000 on your local machine.
  </Step>

  <Step>
    In your web browser, open `127.0.0.1:5000`. The application looks like the following:

    <Frame>
      <img alt="Gemini ADK" />
    </Frame>
  </Step>

  <Step>
    Enter a prompt in the **Type a Message** box. Gemini uses the Connect AI tools such as `getCatalogs`, `getSchemas`, and `getTables` to retrieve data from connected data sources.

    <Frame>
      <img alt="Gemini ADK Prompt" />
    </Frame>
  </Step>
</Steps>


# Gemini Enterprise
Source: https://docs.cloud.cdata.com/en/Clients/GeminiEnterprise-Client

Gemini Enterprise is Google's enterprise AI assistant, available as part of Google Workspace. This page explains how to connect CData Connect AI to Gemini Enterprise as a custom MCP server data store, enabling natural language queries over live data.

## Prerequisites

Before you can configure and use Gemini Enterprise with Connect AI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Have a [Gemini Enterprise](https://cloud.google.com/gemini-enterprise) account (trial available).
* Have a Google Cloud project with billing enabled.
* In your Google Cloud account:
  * Override the organization policy for Custom MCP data stores. [Learn more](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/custom-mcp-server/override-constraint-for-custom-mcp-data-stores).
  * Grant the **Discovery Engine Editor** role to the administrator. [Learn more](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/custom-mcp-server/set-up-custom-mcp-server#before_you_begin).

## Create an OAuth App in CData Connect AI

Gemini Enterprise uses OAuth 2.0 to authenticate users against the CData Connect AI MCP Server. This requires a user-based OAuth App in your CData Connect AI account.

<Steps>
  <Step>
    Click the gear icon in the top-right corner of Connect AI to open **Settings**.
  </Step>

  <Step>
    Navigate to **OAuth Apps** and click **+ Create App**. The **Create OAuth App** dialog appears.
  </Step>

  <Step>
    Enter the following settings:

    * **Name**–enter a descriptive name (for example, *GeminiEnterpriseOAuth*).
    * **Application Type**–select **Web Application**.
    * **Callback URL**–enter *[https://vertexaisearch.cloud.google.com/oauth-redirect](https://vertexaisearch.cloud.google.com/oauth-redirect)*.

    <Frame>
      <img alt="Creating an OAuth App in CData Connect AI" />
    </Frame>
  </Step>

  <Step>
    Click **Confirm**. CData Connect AI generates a **Client ID** and **Client Secret**.
  </Step>

  <Step>
    Copy both the **Client ID** and **Client Secret**. You will need them in the next section.

    <Frame>
      <img alt="Client ID and Client Secret" />
    </Frame>
  </Step>
</Steps>

## Create the Custom MCP Server Data Store

<Steps>
  <Step>
    Open **Gemini Enterprise** and navigate to the **Data stores** screen.
  </Step>

  <Step>
    Click **+ Create data store**.
  </Step>

  <Step>
    On the **Select a data source** page, search for *Custom MCP Server* and click **Add MCP server**.
  </Step>

  <Step>
    In the **Authentication settings** section, enter the following:

    * **MCP Server URL**–enter *[https://mcp.cloud.cdata.com/mcp](https://mcp.cloud.cdata.com/mcp)*.
    * **Authorization URL**–enter *[https://cloud-login.cdata.com/authorize](https://cloud-login.cdata.com/authorize)*.
    * **Token URL**–enter *[https://cloud-login.cdata.com/oauth/token](https://cloud-login.cdata.com/oauth/token)*.
    * **Client ID** and **Client Secret**–from the OAuth App created above.

    <Frame>
      <img alt="Entering MCP server configuration details" />
    </Frame>
  </Step>

  <Step>
    Click **Login** and complete the sign-in.
  </Step>

  <Step>
    Click **Continue**. The **Advanced options** section opens.
  </Step>

  <Step>
    In the **MCP Server Description** field, enter a description that helps Gemini Enterprise understand what the server does and when to use it.
  </Step>

  <Step>
    Click **Continue**.
  </Step>

  <Step>
    In the **Configure your data connector** section, select the **Location of your data connector** from the **Multi-region** field list.
  </Step>

  <Step>
    In **Your data connector name**, enter a name for your data store.
  </Step>

  <Step>
    Click **Create**. Gemini Enterprise creates your data store.
  </Step>
</Steps>

## Enable Actions

After creating the data store, you must enable at least one action before it can be used in Gemini Enterprise.

<Note>
  By default, no tools or actions from your custom MCP server are enabled after the data store is created.
</Note>

<Steps>
  <Step>
    Go to your custom MCP server data store.
  </Step>

  <Step>
    Open the **Actions** tab and click **Reload custom actions** to authenticate and retrieve available tools.

    <Note>
      This performs a `tools/list` call on the MCP server to retrieve available tools, which are then displayed on the screen.
    </Note>
  </Step>

  <Step>
    Select the actions to enable.
  </Step>

  <Step>
    Click **Enable actions**.

    <Frame>
      <img alt="Enabling actions in the data store" />
    </Frame>
  </Step>
</Steps>

## Connect the Data Store to a Gemini Enterprise App

<Steps>
  <Step>
    In the Google Cloud console, go to the [Gemini Enterprise page](https://console.cloud.google.com/gemini-enterprise/start).
  </Step>

  <Step>
    From the navigation menu, click **Apps**.
  </Step>

  <Step>
    Select the Gemini Enterprise app where you want to connect your data store.
  </Step>

  <Step>
    From the navigation menu of the app, click **Connected data stores**.
  </Step>

  <Step>
    Click **Add existing data stores** and select your data store.
  </Step>

  <Step>
    Click **Connect**.

    <Frame>
      <img alt="Connecting the data store to a Gemini Enterprise app" />
    </Frame>
  </Step>
</Steps>

## Query Live Data with Natural Language

With the data store connected, you can query live data using natural language from the Gemini Enterprise web application. Each user authorizes CData Connect AI on first use.

<Steps>
  <Step>
    Open **Gemini Enterprise** and click the connections icon. Click **Authorize** next to **CData Connect AI** and complete the sign-in.

    <Frame>
      <img alt="Authorizing CData Connect AI in Gemini Enterprise" />
    </Frame>
  </Step>

  <Step>
    Ask natural language questions about your data, such as:

    * "Show me all records from the last 30 days"
    * "What are the top accounts by revenue?"
    * "List all active opportunities and their current status"
    * "Summarize activity for this quarter"
  </Step>

  <Step>
    The agent automatically discovers available connections in Connect AI, generates SQL, and returns results—all without requiring you to write queries or understand the underlying data structure.
  </Step>
</Steps>


# GitHub Copilot
Source: https://docs.cloud.cdata.com/en/Clients/GitHubCopilot-Client



Connect AI uses OAuth authentication by default, but you can also use Basic authentication with a Personal Access Token (PAT).

## Prerequisites

Before you can configure and use GitHub Copilot with Connect AI, you must do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

* Install and enable GitHub Copilot in Visual Studio Code (or any IDE supporting GitHub Copilot).

* (Basic authentication only) Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

* (Basic authentication only) Base64-encode your Connect AI credentials in the following format: `Base64("email:PAT")`.

## Connect to Connect AI

### OAuth Authentication

<Steps>
  <Step>
    Create a folder named `.vscode` in your project repository. Within this folder, create a file named `mcp.json` and add the following configuration.

    ```json theme={null}
    {
      "servers": {
          "cdata-mcp": {
          "type": "http",
          "url": "https://mcp.cloud.cdata.com/mcp"
       }
      },
     "inputs": []
    }
    ```
  </Step>

  <Step>
    Click **Start** within your IDE to start the MCP server. Visual Studio Code opens your browser to the Connect AI sign-in page. Complete the sign-in to authorize the connection.
  </Step>

  <Step>
    After authorization, the MCP server displays **Running**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>

### Basic Authentication

<Steps>
  <Step>
    Create a folder named `.vscode` in your project repository. Within this folder, create a file named `mcp.json` and add the following configuration. Replace `YOUR_BASE64_ENCODED_EMAIL:PAT` with the Base64-encoded value of `email:PAT` that you created in the prerequisites.

    ```json theme={null}
    {
      "servers": {
          "cdata-mcp": {
          "type": "http",
          "url": "https://mcp.cloud.cdata.com/mcp",
          "headers": {
             "Authorization": "Basic YOUR_BASE64_ENCODED_EMAIL:PAT"
         }
       }
      },
     "inputs": []
    }
    ```
  </Step>

  <Step>
    Click **Start** within your IDE to start the MCP server. If the MCP server starts without error, it displays **Running**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>

## Add the Connect AI Tools

<Steps>
  <Step>
    Toggle **Chat** in the title bar to display the **Chat** pane on the right.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Add Context** in the bottom of the **Chat** pane. In the search bar, select **Tools**. Then search for *CData*. Add **cdata-mcp All Tools**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>

## Chat with GitHub Copilot

You can now chat with GitHub Copilot and issue contextual prompts. As a test, you can provide the MCP server with a prompt, such as a list of tables for a particular connection. GitHub Copilot uses the Connect AI tools such as `getCatalogs`, `getSchemas`, and `getTables` to retrieve data from the connected data source.

<Frame>
  <img alt="" />
</Frame>


# Grok
Source: https://docs.cloud.cdata.com/en/Clients/Grok-Client

The Connect AI Remote MCP Service enables Grok to securely read and take action on your data in real time.

This page outlines the steps to configure Grok to use the Connect AI Remote MCP Service. You can then use natural language to query your data in real time.

## Prerequisites

Before you can configure and use Grok with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Configure the Connect AI MCP Server

<Steps>
  <Step>
    Log in to Grok.
  </Step>

  <Step>
    In the navigation pane, click **Skills and Connectors**.
  </Step>

  <Step>
    Click the **Connectors** tab, and then click **New Connector**.
  </Step>

  <Step>
    In the **New Connector** dialog, select **Custom—Add your own custom Connector** and enter the following details:

    * **Name**–enter a name for the connector, such as *CData Remote MCP*.
    * **Server URL**–enter the URL for the MCP server: *[https://mcp.cloud.cdata.com/mcp](https://mcp.cloud.cdata.com/mcp)*.

    <Frame>
      <img alt="Grok MCP" />
    </Frame>
  </Step>

  <Step>
    When prompted, log in to Connect AI. If your login is successful, the connector appears in the list of installed connectors.
  </Step>

  <Step>
    Click the new connector you created. This step ensures that Grok can securely route queries through the CData Remote MCP Server to your data.

    <Frame>
      <img alt="Grok New Connector" />
    </Frame>
  </Step>

  <Step>
    Click **New Chat**, and then click the **+** icon and ensure that your new connector is enabled.

    <Frame>
      <img alt="Grok Tools" />
    </Frame>
  </Step>

  <Step>
    You can run a discovery query such as *Get catalogs* or *Get tables* to see the available data sources and schemas connected through Connect AI.

    <Frame>
      <img alt="Grok Catalogs" />
    </Frame>
  </Step>

  <Step>
    You can now begin using natural language to query your data. For a more complete list of prompt ideas, see the CData [prompt library](https://www.cdata.com/ai/prompt-library/). You can filter prompts by data source.
  </Step>
</Steps>


# LangChain
Source: https://docs.cloud.cdata.com/en/Clients/LangChain-Client

LangChain is a framework for developing applications powered by large language models (LLMs).

## Prerequisites

Before you can configure and use LangChain with Connect AI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.
* Obtain an OpenAI API key: [https://platform.openai.com/](https://platform.openai.com/).
* Make sure you have Python >= 3.10 in order to install the LangChain and LangGraph packages.

## Create the Python Files

<Steps>
  <Step>
    Create a folder for LangChain MCP.
  </Step>

  <Step>
    Create two Python files within the folder: `config.py` and `langchain.py`.
  </Step>

  <Step>
    In `config.py`, create a class `Config` to define your MCP server authentication and URL. You need to provide your Base64-encoded Connect AI username and PAT (obtained in the prerequisites):
  </Step>
</Steps>

```python theme={null}
class Config:
    MCP_BASE_URL = "https://mcp.cloud.cdata.com/mcp"   #MCP Server URL
    MCP_AUTH = "base64encoded(EMAIL:PAT)"   #Base64 encoded Connect AI Email:PAT
```

<Steps>
  <Step>
    In `langchain.py`, set up your MCP server and MCP client to call the tools and prompts:
  </Step>
</Steps>

```python expandable theme={null}
"""
Integrates a LangChain ReAct agent with CData Connect AI MCP server.
The script demonstrates fetching, filtering, and using tools with an LLM for agent-based reasoning.
"""
import asyncio
from langchain_mcp_adapters.client import MultiServerMCPClient
from langchain_openai import ChatOpenAI
from langgraph.prebuilt import create_react_agent
from config import Config

async def main():
    # Initialize MCP client with one or more server URLs
    mcp_client = MultiServerMCPClient(
        connections={
            "default": {  # you can name this anything
                "transport": "streamable_http",
                "url": Config.MCP_BASE_URL,
                "headers": {"Authorization": f"Basic {Config.MCP_AUTH}"},
            }
        }
    )
    # Load remote MCP tools exposed by the server
    all_mcp_tools = await mcp_client.get_tools()
    print("Discovered MCP tools:", [tool.name for tool in all_mcp_tools])
    # Create and run the ReAct style agent
    llm = ChatOpenAI(
        model="gpt-4o",
        temperature=0.2,
        api_key="YOUR_OPEN_API_KEY"   #Use your OpenAPI Key here. This can be found here: https://platform.openai.com/.
    )
    agent = create_react_agent(llm, all_mcp_tools)
    user_prompt = "Tell me how many sales I had in Q1 for the current fiscal year."   #Change prompts as per need
    print(f"\nUser prompt: {user_prompt}")
    # Send a prompt asking the agent to use the MCP tools
    response = await agent.ainvoke(
        { "messages": [{ "role": "user", "content": (user_prompt),}]}
    )
    # Print out the agent's final response
    final_msg = response["messages"][-1].content
    print("Agent final response:", final_msg)

if __name__ == "__main__":
    asyncio.run(main())
```

## Install the LangChain and LangGraph Packages

Run `pip install langchain-mcp-adapters langchain-openai langgraph` in your project terminal.

## Run the Python Script

<Steps>
  <Step>
    When the installation finishes, run `python langchain.py` to execute the script.
  </Step>

  <Step>
    The script discovers the Connect AI MCP tools needed for the LLM to query the connected data.
  </Step>

  <Step>
    Supply a prompt for the agent. The agent provides a response.
  </Step>
</Steps>

<Frame>
  <img alt="LangChain Terminal" />
</Frame>


# LangGraph
Source: https://docs.cloud.cdata.com/en/Clients/LangGraph-Client

LangGraph is a framework for developing applications powered by large language models (LLMs).

## Prerequisites

Before you can configure and use LangGraph with Connect AI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.
* Obtain an OpenAI API key: [https://platform.openai.com/](https://platform.openai.com/).
* Make sure you have Python >= 3.10 in order to install the LangChain and LangGraph packages.

## Create the Python Files

<Steps>
  <Step>
    Create a folder for LangGraph MCP.
  </Step>

  <Step>
    Create a Python file within the folder called `langraph.py`.
  </Step>

  <Step>
    Paste the following text into `langraph.py`. You need to provide your Base64-encoded Connect AI username and PAT (obtained in the prerequisites).

    ```bash expandable theme={null}
    """
    LangGraph + MCP + OpenAI Integration
    Pure LangGraph implementation without LangChain
    """
    import asyncio
    from typing import Any
    from langgraph.graph import StateGraph, START, END
    from langgraph.prebuilt import create_react_agent
    from langchain_mcp_adapters.client import MultiServerMCPClient
    from langchain_openai import ChatOpenAI
    from langchain_core.messages import BaseMessage, HumanMessage, AIMessage, ToolMessage
    from typing_extensions import TypedDict, Annotated
    import operator

    class AgentState(TypedDict):
        """State for the LangGraph agent"""
        messages: Annotated[list[BaseMessage], operator.add]

    async def main():
        # Configuration
        MCP_BASE_URL = "https://mcp.cloud.cdata.com/mcp"
        MCP_AUTH = "YOUR_BASE64_ENCODED_EMAIL:PAT"
        OPENAI_API_KEY = "YOUR_OPENAI_API_KEY"
        
        # Step 1: Connect to MCP server
        print("🔗 Connecting to MCP server...")
        mcp_client = MultiServerMCPClient(
            connections={
                "default": {
                    "transport": "streamable_http",
                    "url": MCP_BASE_URL,
                    "headers": {"Authorization": f"Basic {MCP_AUTH}"} if MCP_AUTH else {},
                }
            }
        )
        
        # Step 2: Load all available tools from MCP
        print("📦 Loading MCP tools...")
        all_mcp_tools = await mcp_client.get_tools()
        tool_names = [tool.name for tool in all_mcp_tools]
        print(f"✅ Found {len(tool_names)} tools: {tool_names}\n")
        
        # Step 3: Initialize OpenAI LLM
        print("🤖 Initializing OpenAI LLM...")
        llm = ChatOpenAI(
            model="gpt-4o",
            temperature=0.2,
            api_key=OPENAI_API_KEY
        )
        
        # Step 4: Create LangGraph agent
        print("⚙️ Creating LangGraph agent...\n")
        agent = create_react_agent(llm, all_mcp_tools)
        
        # Step 5: Create the graph
        builder = StateGraph(AgentState)
        builder.add_node("agent", agent)
        builder.add_edge(START, "agent")
        builder.add_edge("agent", END)
        graph = builder.compile()
        
        # Step 6: Run agent with your query
        user_prompt = "List down the first record from the Activities table from ActCRM1"
        print(f"❓ User Query: {user_prompt}\n")
        print("🔄 Agent is thinking and using tools...\n")
        
        initial_state = {
            "messages": [HumanMessage(content=user_prompt)]
        }
        
        result = await graph.ainvoke(initial_state)
        
        # Step 7: Print final response
        final_response = result["messages"][-1].content
        print(f"✨ Agent Response:\n{final_response}")

    if __name__ == "__main__":
        asyncio.run(main())
    ```
  </Step>
</Steps>

## Install the LangChain and LangGraph Packages

Run `pip install -U langgraph langchain langchain-openai langchain-mcp-adapters typing-extensions` in your project root terminal.

## Run the Python Script

<Steps>
  <Step>
    When the installation finishes, run `python langraph.py` to execute the script.
  </Step>

  <Step>
    The script discovers the Connect AI MCP tools needed for the LLM to query the connected data.
  </Step>

  <Step>
    Supply a prompt for the agent. The agent provides a response.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# LlamaIndex
Source: https://docs.cloud.cdata.com/en/Clients/LlamaIndex-Client

LlamaIndex is a framework for building LLM-powered applications that use your own data.

## Prerequisites

Before you can configure and use LlamaIndex with Connect AI, you must do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.
* Obtain an OpenAI API key: [https://platform.openai.com](https://platform.openai.com/).
* Make sure you have Python >= 3.10 in order to install the LlamaIndex packages.

## Create the Python Files

<Steps>
  <Step>
    Create a folder for LlamaIndex MCP.
  </Step>

  <Step>
    Create a Python file within the folder called `llamaindex.py`.
  </Step>

  <Step>
    In `llamaindex.py`, set up your MCP server and MCP client to call the tools and prompts. For `Authorization`, you need to provide your Base64-encoded Connect AI username and PAT (obtained in the prerequisites) after `Basic`.
  </Step>
</Steps>

```python theme={null}
from llama_index.llms.openai import OpenAI
from llama_index.tools.mcp import BasicMCPClient, aget_tools_from_mcp_url
from llama_index.core.agent import ReActAgent
import asyncio

client = BasicMCPClient(
    "https://mcp.cloud.cdata.com/mcp",
    headers={"Authorization": "Basic Base64-encoded (CONNECTAI_USERNAME:PAT)"}
)

async def main():
    # List available tools
    tools = await aget_tools_from_mcp_url("https://mcp.cloud.cdata.com/mcp", client=client)
   
    llm = OpenAI(model="gpt-4o", api_key="YOUR_OPENAI_KEY")   
    # Create ReActAgent
    agent = ReActAgent(tools=tools, llm=llm, verbose=True)
    # # Run a query
    response = await agent.run("List all the catalogs for me please")
    print(response)

asyncio.run(main())
```

## Install the LlamaIndex Packages

Run `pip install llama-index llama-index-llms-openai llama-index-tools-mcp` in your project terminal.

## Run the Python Script

<Steps>
  <Step>
    When the installation finishes, run `python llamaindex.py` to execute the script.
  </Step>

  <Step>
    The script discovers the Connect AI MCP tools needed for the LLM to query the connected data.
  </Step>

  <Step>
    Supply a prompt for the agent. The agent provides a response.
  </Step>
</Steps>

<Frame>
  <img alt="LlamaIndex Terminal" />
</Frame>


# Lovable
Source: https://docs.cloud.cdata.com/en/Clients/Lovable-Client

Lovable is an AI platform that allows you to create apps and websites. You can build applications in Lovable based on your Connect AI data.

## Prerequisites

Before you can configure and use Lovable with Connect AI, you must first do the following:

* Ensure you are on a Business or Enterprise plan with Lovable.

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Connect Lovable to the Connect AI MCP

<Steps>
  <Step>
    In Lovable, navigate to **Settings** > **Connectors** > **Personal Connectors**.
  </Step>

  <Step>
    Find **New MCP server** and click **Set up**.

    <Frame>
      <img alt="New MCP server" />
    </Frame>
  </Step>

  <Step>
    Enter the following setup details:

    * **Server Name**–enter your user-defined server name, such as *Custom MCP server*.
    * **Server URL**–enter *[https://mcp.cloud.cdata.com/mcp](https://mcp.cloud.cdata.com/mcp)*.
    * **Authentication**–select **OAuth**.
  </Step>

  <Step>
    Authenticate using your CData Connect AI account email (such as [user@cdata.com](mailto:user@cdata.com)) and password. Once authentication is successful, your available CData connectors appear in the connectors list.
  </Step>

  <Step>
    Click **Manage Permissions** to set permissions for the tools exposed by the MCP server.

    <Frame>
      <img alt="Manage permissions" />
    </Frame>
  </Step>

  <Step>
    You can now run a test prompt to make sure Lovable is successfully communicating with the CData MCP Server. For example, enter the prompt ***List all MCP tools.*** The output returns a list of tools, such as `getCatalogs`, `queryData`, and others.
  </Step>

  <Step>
    You can now query your connected data source(s) in Connect AI using natural language prompts, such as ***Get all data from the Dnd table from the Slack connection*** or ***Get the top 10 records from the Automations table from the MailChimp connection***.

    <Frame>
      <img alt="Sample Lovable prompt" />
    </Frame>

    <Note>
      For a list of prompt ideas, see CData's [prompt library](https://www.cdata.com/solutions/mcp/prompt-library/).
    </Note>
  </Step>
</Steps>


# Microsoft Copilot Studio
Source: https://docs.cloud.cdata.com/en/Clients/MicrosoftCopilot-Client



## Prerequisites

Make sure you have a Connect AI account and are signed in. Go to [https://www.cdata.com/ai](https://www.cdata.com/ai).

Before you can configure and use Microsoft Copilot Studio with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

<Warning>
  If you are using a custom OAuth app in Connect AI with Microsoft 365 Copilot or an MCP plugin, you must add the following redirect URI to your app registration before creating a connection: *[https://teams.microsoft.com/api/platform/v1.0/oAuthRedirect](https://teams.microsoft.com/api/platform/v1.0/oAuthRedirect)*.

  Without this redirect URI, users will encounter token exchange failures or a frozen sign-in screen.
</Warning>

## Create a Microsoft Copilot Studio Agent

<Steps>
  <Step>
    In the Copilot Studio navigation menu, click **Agents**, and then click **+New agent**.
  </Step>

  <Step>
    Toggle the **Configure** button.
  </Step>

  <Step>
    Enter information based on how you intend to use this agent while it is consuming our MCP server.
  </Step>

  <Step>
    Click **Create** on the upper right. Copilot shows you the agent details.
  </Step>
</Steps>

<Frame>
  <img alt="Copilot Agent" />
</Frame>

## Add the CData Connect AI Tool to the Agent

<Steps>
  <Step>
    Scroll down the agent details until you see the **Add tool** button. Click this button.
  </Step>

  <Step>
    In the **Add Tool** dialog, search for *CData Connect AI* and click the tool **CData Connect AI**.

    <Frame>
      <img alt="Copilot Add Tool" />
    </Frame>
  </Step>

  <Step>
    Under **Connection**, click **Create new connection**.

    <Frame>
      <img alt="Copilot New Connection" />
    </Frame>
  </Step>

  <Step>
    In the next dialog, click **Create**.
  </Step>

  <Step>
    Sign in to Connect AI with your credentials, if necessary.
  </Step>

  <Step>
    Click **Add to agent**. The MCP tool is now listed under the **Tools** section for your agent. You can now test your agent.
  </Step>
</Steps>

## Explore Live Data

With the Agent created in Microsoft Copilot Studio and the MCP tool connected, you can now interact with your data. The MCP tool allows you to send queries and receive responses from the data source in real time.

Open the chat window in your Microsoft Copilot Studio Agent to begin interacting with your data. You can ask questions, retrieve data, and perform actions on your data using the MCP tool.

<Frame>
  <img alt="Copilot Explore Data" />
</Frame>


# Data Explorer
Source: https://docs.cloud.cdata.com/en/Data-Explorer

The ***Data Explorer*** page enables you to execute basic queries on your connected data sources, browse your data models, and create derived views. You can also create saved queries, add assets to a workspace, and create cache jobs.

Data Explorer can be useful to:

* Verify that your data sources are connected correctly
* Explore the columns and data types that are available in your data sources
* Search for specific data in your data sources using the SQL Editor or the [Query Builder](/en/QueryBuilder).

When you first open Data Explorer, the interface displays a navigation pane on the left and the query editor on the right. Select whether you want to build your query in the Query Builder or the SQL Editor. If you click **Build Query**, the Query Builder guides you through the steps of creating a query. If you click **SQL Editor**, an SQL editor appears.

<Frame>
  <img alt="Data Explorer" />
</Frame>

<Note>Alternatively, you can use AI to explore your data. Click **Get Started** to launch [Playground](/en/Playground) or [MCP Integrations](/en/Integrations).</Note>

You can use the Data Explorer to view workspaces, saved queries, derived views, and connections. Click the arrow to the right to view the contents of the connection or workspace. Connections may consist of multiple schema. If there is only one schema in a connection, the schema is already open to a list of tables in the schema. If there are multiple schemas, open the desired schema to view the list of tables.

You can use the search bar to search for connections. Once you are within a connection, you can use the search bar to search for schemas and tables.

At any time in the Data Explorer, you can click the **Home** tab on the right side to select between Query Builder and SQL Editor. You can also click the plus button to add a new tab of your choice (Query Builder or SQL Editor). The tab titles display whether the query is a Query Builder query or a SQL Editor query.

## Use the SQL Editor

The SQL Editor allows you to create, modify, and save queries.

<Note>
  For instructions on using the Query Builder to build queries, refer to [Query Builder](/en/QueryBuilder).
</Note>

### Create a Query in the SQL Editor

Follow these steps to execute a query using the SQL Editor in the Data Explorer:

<Steps>
  <Step>
    Select a table or view in a connection or workspace, or select a saved query or derived view. All available items appear in the left column.

    * The solid table icon indicates a table.
    * The dashed square icon indicates a view.
    * The blue double document icon to the right of the item indicates that the item is being cached. See [Caching](/en/Caching) for more information.
  </Step>

  <Step>
    Select the data that you want to query.

    * To view the SQL query for an entire table or view, click that table or view. Alternatively, click the three dots next to the table or view and select **Open**. The SQL query appears on the right. Column details appear below the SQL query. This query is read-only until you execute it.
    * Click the three dots next to the table or view and select **Query** to create a new query based on the table or view. You can edit the query before you execute it.
    * Some data source types contain SQL templates for commonly-used queries. These queries appear under **Common Queries** when you expand the connection name. Click the three dots next to the query name and click **Query** to view the query. You can edit the query, if needed, before you execute it.

    Alternatively, you can enter a query manually by clicking the + sign in the tab bar and selecting **SQL Editor**. Use SQL syntax in the SQL Editor. Connect AI has an autocomplete feature to assist you with SQL syntax.

    <Frame>
      <img alt="SQL syntax help" />
    </Frame>

    The SQL Editor also autocompletes connection, schema, and table names. Once you pick a connection, autocomplete lets you select a schema from a drop-down list. You can then select a table within the schema.

    <Frame>
      <img alt="Autocomplete" />
    </Frame>
  </Step>

  <Step>
    Set the **Limit** field to the number of results that you want to return. By default, the limit is 100. You can set any limit, but you MUST enter a value in this field. (Do not use the SQL LIMIT clause.)
  </Step>

  <Step>
    Click **Execute** to run the query.

    When you execute the query, a loading icon appears in the **Results** section, along with a time elapsed notification. The loading icon also appears in the query's tab.

    If your time elapsed exceeds five minutes, please contact [CData support](https://www.cdata.com/support/submit.aspx) for assistance.
  </Step>

  <Step>
    When the query is finished executing, your results appear under the query editor. You can scroll through pages and adjust the number of results per page by using the fields at the bottom of the page. You can also adjust the column widths of the results.

    If your query returns an error, an error message appears above the query. An error icon also appears in the query's tab. Click **Learn More** for more details about the error.

    <Frame>
      <img alt="Query error" />
    </Frame>
  </Step>
</Steps>

### Modify a Query

After a read-only query executes, a new tab appears with a name such as **Query 1**. You can then modify the query and save it with a new name.

* Modify the query manually by entering query parameters into the query editor.
* Clear the query editor by selecting **Clear** and then clicking **OK** in the prompt that is displayed.

### Save a Query

Data Explorer provides the ability to save queries and return to them later without the need to re-enter the query parameters each time.

After you create and successfully execute a query, the **Save** button at the top of the Data Explorer pane becomes available. Follow these steps to save a query and access it later:

<Steps>
  <Step>
    Click **Save** > **Save as Saved Query**. The **Save Query** dialog appears.
  </Step>

  <Step>
    Enter a name for the query and click **Confirm**.
  </Step>

  <Step>
    The Data Explorer Saved Queries menu opens, and your newly-saved query appears in the list.
  </Step>
</Steps>

<Tip>
  You can also click the down arrow to the right of the query's tab and select **Rename Tab**. Rename the query and click **Confirm**.
</Tip>

#### Use Saved Queries

Saved queries are available in the **Saved Queries** folder in the Data Explorer navigation pane, and saved derived views are available in the **Derived Views** folder. To execute a saved query, click the three dots next to the saved query name and select **Query**. The contents of the saved query populate in the Query Editor, and you can click **Execute** to retrieve the results.

You can also rename and delete saved queries when you click the three dots.

## Add to a Workspace

You can use the Data Explorer to add assets to a workspace.

<Steps>
  <Step>
    Click the table or view you want to add to a workspace. Connect AI calls contents of a workspace *assets*.
  </Step>

  <Step>
    Click the three dots next to the asset and select **Add to Workspace**.
  </Step>

  <Step>
    Select the workspace to move the asset to and click **Confirm**.
  </Step>
</Steps>

## Configure Derived Views

The *derived views* feature of Data Explorer allows you to create and save queries that return dynamically populated data results from your connections. You can query your saved derived views from [Integrations](/en/Integrations), and the results automatically update when the data in your connections changes.

<Note>
  Only administrators of Connect AI can create or modify derived views. Query users can query saved derived views created by an administrator.
</Note>

### Create a Derived View

To create a new derived view, follow these steps:

<Steps>
  <Step>
    Create the query in the Query Builder or SQL Editor. After you execute the query, the **Save** button appears. Click **Save** > **Save as Derived View**. The **Create Derived View** dialog appears.
  </Step>

  <Step>
    Enter a name for the derived view in the **View Name** field. This is the name that appears in the list of saved derived views.
  </Step>

  <Step>
    Click **Confirm** to save the derived view.
  </Step>
</Steps>

### Access a Derived View in Integrations

When issuing queries to a derived view from within an integration tool, set the Connection or Database value to *CData*. The following syntax shows the correct fully-qualified syntax for accessing a derived view:

```sql theme={null}
SELECT * FROM [CData].[DerivedViews].[SampleDerivedView]
```

Substitute the name of your derived view for the \[SampleDerivedView] value in the example above.

### Access a Derived View in Data Explorer

After you create a derived view, it appears in the list of derived views in Data Explorer. You can click the three dots next to the entry in the list to open a list of options.

<Frame>
  <img alt="Query derived view" />
</Frame>

* Select **Open/Edit** to open the derived view in the query editor and edit the view.
* Select **Delete** to remove the derived view from the list.
* Select **Query** to execute the query. The contents of the derived view appear in the Data Explorer query view, and you can then click **Execute** to view the query results.
* Select **Add to Workspace** to add the derived view to a workspace. An **Add to Workspace** dialog appears to select the workspace.

### Modify a Derived View

To modify the query of a derived view, use one of the methods outlined above to access it. With the derived view open, modify the text in the query field as needed and click **Save Changes** at the top of the Data Explorer.

To rename a derived view, click the three dots next to the entry in the list and select **Rename**. Enter the new name in the dialog that appears and click **Confirm**.

### Delete a Derived View

To delete a derived view, click the three dots next to the entry in the list and select **Delete**. In the confirmation dialog that appears, click **Delete** again.

<Note>
  Deleting a derived view does not affect data in the source.
</Note>

## Create Scheduled Queries

You can save a query as a scheduled query. A scheduled query runs at user-defined intervals.

To create a scheduled query:

<Steps>
  <Step>
    Create your query using the Query Builder or the SQL Editor.
  </Step>

  <Step>
    Click **Save** > **Save as Scheduled Query**.
  </Step>

  <Step>
    You then enter the details about the scheduled query, such as how often it runs. See [Scheduled Queries](/en/Scheduled-Queries) for details.
  </Step>
</Steps>

## Add to a Workspace

You can use the Data Explorer to add assets to a workspace.

<Steps>
  <Step>
    Click the table or view you want to add to a workspace. Connect AI calls contents of a workspace *assets*.
  </Step>

  <Step>
    Click the three dots next to the asset and select **Add to Workspace**.
  </Step>

  <Step>
    Select the workspace to move the asset to and click **Confirm**.
  </Step>
</Steps>

## Add a Cache Job

You can use the Data Explorer to cache the data for a table or view. Caching allows you to fetch cached data from a database instead of retrieving live data, improving performance. See [Caching](/en/Caching) for details.

To add a cache job:

<Steps>
  <Step>
    Click the table or view you want to cache.
  </Step>

  <Step>
    Click the three dots next to the asset and select **Add Cache Job**. You are redirected to the **Edit Job** page.
  </Step>

  <Step>
    Follow the instructions in [Edit a Cache Job](/en/Caching#edit-a-cache-job).
  </Step>
</Steps>


# Sendwithus
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-SendWithUs



## Prerequisites

Before you can add the connection, you must obtain an API key from your Sendwithus account:

<Steps>
  <Step>
    Log in to your Sendwithus account and go to **API Settings**.
  </Step>

  <Step>
    Click **Create New API Key** and copy the generated key.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Sendwithus to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Sendwithus* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Sendwithus account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SendPulse
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Sendpulse



## Prerequisites

Before you can add the connection, you must obtain OAuth credentials from your SendPulse account:

<Steps>
  <Step>
    Log in to your SendPulse account.
  </Step>

  <Step>
    Navigate to **Account Settings** and open the **API** tab.
  </Step>

  <Step>
    Locate your **Client ID** and **Secret Key** and copy both values.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SendPulse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SendPulse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from your SendPulse account.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the SendPulse sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your SendPulse account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# ServiceDesk Plus
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ServiceDeskPlus



## Prerequisites

ServiceDesk Plus uses Zoho OAuth 2.0 for secure authentication. Before you can add the connection, you must register an OAuth application in the Zoho Developer Console:

<Steps>
  <Step>
    Go to the [Zoho Developer Console](https://api-console.zoho.com) and sign in.
  </Step>

  <Step>
    Register your application and set the redirect URI to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Make note of the **Client ID** and **Client Secret** from the application settings.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect ServiceDesk Plus to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *ServiceDesk Plus* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **Portal** field, enter your ServiceDesk Plus portal identifier for multi-tenant environments.
  </Step>

  <Step>
    In the **Domain** field, select the regional domain of your ServiceDesk Plus account (for example, **.com**, **.eu**, **.com.au**, **.in**). The default is **.com**.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained when registering your OAuth application.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the ServiceDesk Plus sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# ShipEngine
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ShipEngine



## Prerequisites

Before you can add the connection, you must retrieve your API key from the ShipEngine Dashboard:

<Steps>
  <Step>
    Log in to the ShipEngine Dashboard and navigate to [API Management](https://app.shipengine.com/#/portal/apimanagement).
  </Step>

  <Step>
    Copy your API key. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect ShipEngine to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *ShipEngine* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Shippo
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Shippo



## Prerequisites

Before you can add the connection, you must generate an API token from Shippo:

<Steps>
  <Step>
    Log in to your Shippo account and navigate to **Settings**, then **API**, then click **Generate Token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Shippo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Shippo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Shortcut
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Shortcut



## Prerequisites

Before you can add the connection, you must generate an API token from your Shortcut account:

<Steps>
  <Step>
    Log in to your Shortcut account at [https://app.shortcut.com/](https://app.shortcut.com/).
  </Step>

  <Step>
    Click your profile icon in the lower-left corner, then select **Settings**.
  </Step>

  <Step>
    Navigate to **API Tokens** under your account settings.
  </Step>

  <Step>
    Click **Generate Token** to create a new API token, then copy it and store it securely.
  </Step>
</Steps>

For more information, see the [Shortcut API Tokens page](https://app.shortcut.com/settings/account/api-tokens).

## Setup Guide

Follow these steps to connect Shortcut to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Shortcut* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Shortcut account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SparkPost
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-SparkPost



## Prerequisites

Before you can add the connection, you must generate an API key from your SparkPost account:

<Steps>
  <Step>
    Log in to your SparkPost account and go to **Configuration** > **API Keys**.
  </Step>

  <Step>
    Click **Create API Key**, assign the permissions your integration requires, then create the key.
  </Step>

  <Step>
    Copy the key and store it securely. SparkPost displays the key only once.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SparkPost to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SparkPost* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your SparkPost account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Stack Exchange
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-StackExchange



## Prerequisites

Before you can add the connection, you must register an application on StackApps to obtain a request key:

<Steps>
  <Step>
    Log in to [stackapps.com](https://stackapps.com) with your Stack Exchange account.
  </Step>

  <Step>
    Navigate to **stackapps.com/apps/oauth/register**.
  </Step>

  <Step>
    Fill in the **Application Name** and **Description** fields, then submit the form.
  </Step>

  <Step>
    Copy the **Key** value from the registered application. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Stack Exchange to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Stack Exchange* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **Site** field, enter the Stack Exchange site you want to query (for example, *stackoverflow*, *superuser*, or *serverfault*).
  </Step>

  <Step>
    Enter your **API Key** (your StackApps request key) from the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Supabase
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Supabase



## Prerequisites

Before you can add the connection, you must generate a Management API token from your Supabase account:

<Steps>
  <Step>
    Log in to your Supabase account and go to **Account Settings** > **Access Tokens**.
  </Step>

  <Step>
    Generate a new token with the appropriate permissions for managing your organizations and projects.
  </Step>

  <Step>
    Copy the token and store it securely. Supabase displays the token only once.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Supabase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Supabase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Supabase Management API token in the **API Key** field.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Tavily
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Tavily



## Prerequisites

Before you can add the connection, you must obtain an API key from your Tavily account:

<Steps>
  <Step>
    Log in to your Tavily account and open your account dashboard.
  </Step>

  <Step>
    Copy your **API key** and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Tavily to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Tavily* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Tavily account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Teamwork
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Teamwork



## Prerequisites

Before you can add the connection, you must register an OAuth application in the Teamwork Developer Portal:

<Steps>
  <Step>
    In a browser, navigate to `https://{yourTeamworkURL}/developer`, replacing `{yourTeamworkURL}` with your Teamwork site URL (for example, [https://acmeinc.teamwork.com/developer](https://acmeinc.teamwork.com/developer)).
  </Step>

  <Step>
    If prompted, complete your publisher details before proceeding.
  </Step>

  <Step>
    Click **Create Your First App** (or **Create App** if you have existing apps).
  </Step>

  <Step>
    Complete the required fields:

    * **Name**—the name of your application.
    * **Product(s)**—select at least one Teamwork product your integration will use.
    * **Redirect URIs**—set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Create App**.
  </Step>

  <Step>
    Open the **Credentials** tab of your new app and copy the **Client ID** and **Client Secret**. Store the client secret securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Teamwork to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Teamwork* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication

<Steps>
  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the Teamwork Developer Portal.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Teamwork sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Teamwork account and grant the requested permissions.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# TestMonitor
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Testmonitor



## Prerequisites

Before you can add the connection, you must create an API key from your TestMonitor account:

<Steps>
  <Step>
    Log in to your TestMonitor account and click **My Account** in the top-right corner.
  </Step>

  <Step>
    Select **API**, then click **Create Token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect TestMonitor to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *TestMonitor* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain**, which is the subdomain of your TestMonitor account URL. For example, if your TestMonitor URL is acmeinc.testmonitor.com, the **Domain** is *acmeinc*.
  </Step>

  <Step>
    Enter the **API Key** created in the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Tickspot
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Tickspot



## Prerequisites

You can obtain your API Token and Subscription Id by querying these values in the Roles table. To query the Roles table, set **User** and **Password** to your Tickspot login email address and password.

## Setup Guide

Follow these steps to connect Tickspot to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Tickspot* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Subscription Id** from your Tickspot account.
  </Step>

  <Step>
    Enter the **API Key** (your Tickspot API Token).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Timely
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Timely



## Prerequisites

Before you can add the connection, you must register a custom OAuth application with Timely:

<Steps>
  <Step>
    Log in to your Timely account and go to **Settings** > **DEVS** > **New Application**.
  </Step>

  <Step>
    Complete the required fields, setting the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*, then create the application.
  </Step>

  <Step>
    Make note of the **Client Id** and **Client Secret** assigned to your application.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Timely to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Timely* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Timely.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Timely sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Timely account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Toggl
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Toggl



## Prerequisites

Before you can add the connection, you must locate your API token in your Toggl Track account:

<Steps>
  <Step>
    Log in to your Toggl Track account and go to your **Profile Settings** page at [https://track.toggl.com/profile](https://track.toggl.com/profile).
  </Step>

  <Step>
    Scroll to the bottom of the page to find your **API Token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Toggl to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Toggl* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** from your Toggl Track profile.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Typeform
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Typeform



## Prerequisites

To use OAuth authentication, register an OAuth application with Typeform:

<Steps>
  <Step>
    Log in to your Typeform account and navigate to the [Typeform Admin Panel](https://admin.typeform.com/account#/section/tokens) to register a new OAuth application.
  </Step>

  <Step>
    Set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Copy the **Client ID** and **Client Secret**. Store the client secret securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Typeform to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Typeform* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication

<Steps>
  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Typeform.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Typeform sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Typeform account and grant the requested permissions.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# UKG Pro HCM
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-UKGProHCM



## Prerequisites

Before you can add the connection, you must obtain your Customer API Key from your UKG Pro HCM account:

<Steps>
  <Step>
    Log in to UKG Pro HCM as an administrator.
  </Step>

  <Step>
    Navigate to **Menu** > **System Configuration** > **Security** > **Web Services**.
  </Step>

  <Step>
    Copy the **Customer API Key** and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect UKG Pro HCM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *UKG Pro HCM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Host**, which is the hostname of the UKG Pro HCM datacenter assigned to your organization.
  </Step>

  <Step>
    Enter the **User** and **Password** for your UKG Pro HCM account.
  </Step>

  <Step>
    Enter the **Customer API Key** obtained from your UKG Pro HCM account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# VWO
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-VWO



## Prerequisites

Before you can add the connection, you must generate an API token from your VWO account:

<Steps>
  <Step>
    Log in to your VWO account at [https://app.vwo.com](https://app.vwo.com). Navigate to the **Developers** tab or section, select the **Tokens** tab, and click **Add another API token**.
  </Step>

  <Step>
    Generate a new token and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect VWO to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *VWO* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your VWO profile.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Wistia
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Wistia



## Prerequisites

When your Wistia account is created, a master token is automatically generated. You can find this token in the **API** tab of your Account Settings.

## Setup Guide

Follow these steps to connect Wistia to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Wistia* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key**, which is the Wistia token obtained in the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Yelp
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Yelp



## Prerequisites

To authenticate to Yelp, you must create an app to obtain a private API Key:

<Steps>
  <Step>
    Log in to [https://www.yelp.com/developers/v3/manage\_app](https://www.yelp.com/developers/v3/manage_app) and complete the required fields to create your app.
  </Step>

  <Step>
    Once the app is created, Yelp automatically generates a private API Key. Copy this key and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Yelp to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Yelp* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from the Yelp Fusion developer portal.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho Desk
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ZohoDesk



## Prerequisites

Before you can add the connection, you need to register a custom OAuth application with Zoho:

<Steps>
  <Step>
    Go to the [Zoho Developer Console](https://accounts.zoho.com/developerconsole) and sign in.
  </Step>

  <Step>
    Add a new client and select **Server-based Applications** as the client type.
  </Step>

  <Step>
    Complete the required fields, setting the **Authorized Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*, then create the client.
  </Step>

  <Step>
    Make note of the **Client Id** and **Client Secret** assigned to your application.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Zoho Desk to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho Desk* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **Organization** field, enter the Id of the Zoho Desk organization you want to connect to. You can find it in the Organizations table.
  </Step>

  <Step>
    (Optional) In the **Domain** field, select the domain where authentication calls are sent (*.com*, *.eu*, *.com.au*, or *.in*). If left empty, the default is *.com*.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Zoho.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho Expense
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ZohoExpense



## Prerequisites

Before you can add the connection, you must register a custom OAuth application with Zoho:

<Steps>
  <Step>
    Go to the [Zoho Developer Console](https://accounts.zoho.com/developerconsole) and sign in.
  </Step>

  <Step>
    Add a new client and select **Server-based Applications** as the client type.
  </Step>

  <Step>
    Complete the required fields, setting the **Authorized Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*, then create the client.
  </Step>

  <Step>
    Make note of the **Client Id** and **Client Secret** assigned to your application.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Zoho Expense to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho Expense* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Zoho.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho Invoice
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ZohoInvoice



## Prerequisites

Before you can add the connection, you must register a custom OAuth application with Zoho:

<Steps>
  <Step>
    Go to the [Zoho Developer Console](https://accounts.zoho.com/developerconsole) and sign in.
  </Step>

  <Step>
    Add a new client and select **Server-based Applications** as the client type.
  </Step>

  <Step>
    Complete the required fields, setting the **Authorized Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*, then create the client.
  </Step>

  <Step>
    Make note of the **Client Id** and **Client Secret** assigned to your application.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Zoho Invoice to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho Invoice* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **Domain** field, enter the domain where authentication calls are sent (*.com*, *.eu*, or *.in*).
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Zoho.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho Marketing Automation
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ZohoMarketingHub



## Prerequisites

Before you can add the connection, you must register a custom OAuth application with Zoho:

<Steps>
  <Step>
    Go to the [Zoho Developer Console](https://accounts.zoho.com/developerconsole) and sign in.
  </Step>

  <Step>
    Add a new client and select **Server-based Applications** as the client type.
  </Step>

  <Step>
    Complete the required fields, setting the **Authorized Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*, then create the client.
  </Step>

  <Step>
    Make note of the **Client Id** and **Client Secret** assigned to your application.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Zoho Marketing Automation to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho Marketing Automation* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set **Domain** to the domain that matches your Zoho account's data center: *com*, *eu*, *com.au*, or *in*.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Zoho.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho People
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ZohoPeople



## Prerequisites

Before you can add the connection, you must register a custom OAuth application with Zoho:

<Steps>
  <Step>
    Go to the [Zoho Developer Console](https://accounts.zoho.com/developerconsole) and sign in.
  </Step>

  <Step>
    Add a new client and select **Server-based Applications** as the client type.
  </Step>

  <Step>
    Complete the required fields, setting the **Authorized Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*, then create the client.
  </Step>

  <Step>
    Make note of the **Client Id** and **Client Secret** assigned to your application.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Zoho People to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho People* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Zoho.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho Subscriptions
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ZohoSubscriptions



## Prerequisites

Before you can add the connection, you must register a custom OAuth application with Zoho:

<Steps>
  <Step>
    Go to the [Zoho Developer Console](https://accounts.zoho.com/developerconsole) and sign in.
  </Step>

  <Step>
    Add a new client and select **Server-based Applications** as the client type.
  </Step>

  <Step>
    Complete the required fields, setting the **Authorized Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*, then create the client.
  </Step>

  <Step>
    Make note of the **Client Id** and **Client Secret** assigned to your application.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Zoho Subscriptions to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho Subscriptions* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **Domain** field, enter the domain where authentication calls are sent (*.com*, *.eu*, *.in*, or *.com.au*).
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Zoho.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoom
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Zoom



## Prerequisites

Before you can add the connection, you need to register an OAuth application on the Zoom App Marketplace.

<Steps>
  <Step>
    Go to the [Zoom App Marketplace](https://marketplace.zoom.us/) and sign in.
  </Step>

  <Step>
    In the **Develop** drop-down menu in the upper-right corner, select **Build App**.
  </Step>

  <Step>
    Select **General App** and click **Create**.
  </Step>

  <Step>
    On the **Basic Information** page, enter an **App Name** and choose how the app is managed (**User-managed** or **Admin-managed**).
  </Step>

  <Step>
    Under **OAuth Information**, set the **OAuth Redirect URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)* and add the same URL to the **OAuth Allow List**.
  </Step>

  <Step>
    On the **Scopes** page, click **Add Scopes** and select the scopes your integration needs, then click **Done**.
  </Step>

  <Step>
    Return to **Basic Information**. Under **App Credentials**, make note of the **Client Id** and **Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Zoom to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoom* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Connect AI, enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Zoom.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoom sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoom account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SFTP
Source: https://docs.cloud.cdata.com/en/Data-Sources/SFTP



## Setup Guide

Follow these steps to connect SFTP to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SFTP* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Remote Host**, which specifies the host name or IP address of the SFTP server that you want to connect to.
  </Step>

  <Step>
    (Optional) Enter the **Remote Path**, which specifies the working directory on the SFTP server that the provider uses for file operations.
  </Step>

  <Step>
    (Optional) Enter the **Remote Port**, which specifies the port number that the provider uses to connect to the SFTP server. By default, most SFTP servers listen on port 22. Set this property if your server uses a different port.
  </Step>

  <Step>
    Select the **SSH Auth Mode** that the provider uses when connecting to the SFTP server, then proceed to the relevant section below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this authentication mode.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="MultiFactor">
    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert**, which is a certificate used for authenticating the SSH user.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert Password**, which is the password of the **SSH Client Cert** key if it has one.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert Subject**, which is the subject of the SSH client certificate. The wildcard value "\*" picks the first certificate in the certificate store.
      </Step>

      <Step>
        (Optional) Select the **SSH Client Cert Type**, which is the type of **SSH Client Cert** private key. Options are **PFXBLOB**, **JKSBLOB**, **PEMKEY\_BLOB**, **PPKBLOB**, and **XMLBLOB**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Password">
    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PublicKey">
    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert**, which is a certificate used for authenticating the SSH user.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert Password**, which is the password of the **SSH Client Cert** key if it has one.
      </Step>

      <Step>
        (Optional) Enter the **SSH Client Cert Subject**, which is the subject of the SSH client certificate. The wildcard value "\*" picks the first certificate in the certificate store.
      </Step>

      <Step>
        (Optional) Select the **SSH Client Cert Type**, which is the type of **SSH Client Cert** private key. Options are **PFXBLOB**, **JKSBLOB**, **PEMKEY\_BLOB**, **PPKBLOB**, and **XMLBLOB**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SFTP, see [this information page](https://cdn.cdata.com/help/SFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SQL Server
Source: https://docs.cloud.cdata.com/en/Data-Sources/SQL



## Prerequisites

#### Whitelist CData IPs

To establish a connection to SQL Server, you need to allow access to SQL Server via CData’s IP. When hosting SQL Server behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure SQL Server Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect SQL Server to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SQL Server* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the **Server** running SQL Server.
  </Step>

  <Step>
    Enter the port for connecting to SQL Server in the **Port** field.
  </Step>

  <Step>
    Enter the name of the **Database** to connect to.
  </Step>

  <Step>
    Select an encryption method in **Encrypt**. You can select **True** (optional encryption), **Strict** (required encryption), or no encryption.
  </Step>

  <Step>
    If your SQL Server connection is behind a firewall, enable the setting **Use SSH** and follow the instructions in [SSH Tunnel Instructions](#ssh-tunnel-instructions). Then, continue with the authentication instructions. Otherwise, leave **Use SSH** off.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        In the **User** field, enter the SQL Server username for authentication.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzurePassword">
    <Steps>
      <Step>
        In the **User** field, enter the SQL Server username for authentication.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id. This value is the directory Id in **Azure Portal** > **Azure Active Directory** > **Properties**. If not specified, the default tenant is used.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the SQL Server sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your SQL Server account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Copy the client Id from SQL Server and paste it in the **OAuth Client Id** field in Connect AI.
      </Step>

      <Step>
        Copy the client secret from SQL Server and paste it in the **OAuth Client Secret** field in Connect AI.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id. This value is the directory Id in **Azure Portal** > **Azure Active Directory** > **Properties**. If not specified, the default tenant is used.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Copy the OAuth JWT certificate store contents and paste it in the **OAuth JWT Cert** field. This is a multi-line key with the format shown.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id. This value is the directory Id in **Azure Portal** > **Azure Active Directory** > **Properties**. If not specified, the default tenant is used.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert Password** for your SQL Server account, if required.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert Subject** for your SQL Server account. This is the subject of the OAuth JWT certificate. If omitted, the first certificate in the certificate store is used.
      </Step>

      <Step>
        Enter your **OAuth Client Id** assigned when you registered your SQL Server account.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## SSH Tunnel Instructions

If your SQL Server data source is behind a firewall, follow these instructions.

<Steps>
  <Step>
    Enable the setting **Use SSH**.
  </Step>

  <Step>
    Enter the following information:

    * **SSH Server**–enter the name of the SSH server.
    * **SSH Port**–enter the SSH port. The default value is 22.
    * **SSH Server Fingerprint**–enter the fingerprint of the SSH server, which is the server's digital Id badge. The fingerprint looks similar to the following: `SHA256:WzAxzZkQ2d5G9V45T2x4FQncpJjUEwEvRQpz+sy9TxY`.
    * **SSH Auth Mode**–enter the authentication mode of **Password** or **Public\_Key**.
      * If **Password**, enter the **SSH User** name and **SSH Password**.
      * If **Public\_Key**, enter the following:
        * **SSH Client Cert**–enter a valid private key.
        * **SSH Client Cert Type**–select the certificate type.
        * **SSH Client Cert Password**–(optional) enter if the SSH client certificate has a password.
        * **SSH Client Cert Subject**–(optional) enter the subject. If the certificate subject is omitted, the first certificate in the certificate store is used.
  </Step>

  <Step>
    Continue with the authentication instructions.
  </Step>
</Steps>

## Private Cloud Connector Connection

SQL Server is a supported connector with Private Cloud Connector, which acts as a bridge between your on-premises data and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information. Once you set up the gateway, you can select the **Connection Type** of **Private Cloud Connector**. Then enter **Location Name** of the gateway and the SQL Server authentication information.

## More Information

For more information about interactions between Connect AI and SQL Server, see [this information page](https://cdn.cdata.com/help/RUM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SendGrid
Source: https://docs.cloud.cdata.com/en/Data-Sources/SendGrid



## Setup Guide

Follow these steps to connect SendGrid to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SendGrid* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** for the Sendgrid connection.
  </Step>

  <Step>
    Select a **Schema** from the drop-down list. The Options are `NMC` or `Legacy`.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SendGrid, see [this information page](https://cdn.cdata.com/help/BGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# ServiceNow
Source: https://docs.cloud.cdata.com/en/Data-Sources/ServiceNow



## Setup Guide

Follow these steps to connect ServiceNow to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *ServiceNow* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the base **URL** of your ServiceNow instance (for example, *[https://MyInstance12345.service-now.com/](https://MyInstance12345.service-now.com/)*).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the ServiceNow username for authentication in the **User** field.
      </Step>

      <Step>
        In **Password**, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** in your app settings.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** in your app settings.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the ServiceNow sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your ServiceNow account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the ServiceNow username for authentication in the **User** field.
      </Step>

      <Step>
        In **Password**, enter the user password.
      </Step>

      <Step>
        Enter the **OAuth Client Id** in your app settings.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** in your app settings.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** in your app settings.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** in your app settings.
      </Step>

      <Step>
        (Optional) Enter the **JTI Claim Name** if you have a different claim name for unique identification of the JWT. The default value, *jti*, is a random UUID.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which is the ServiceNow tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** in your app settings.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** in your app settings.
      </Step>

      <Step>
        Enter the **Scope** of the authenticating user's access to the application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the ServiceNow sign-in page in a new tab.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        Enter the **SSO Properties** with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        Enter the **SSO Properties** with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OneLogin">
    <Steps>
      <Step>
        Enter the OneLogin **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties** with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the PingFederate **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        Enter the **SSO Properties** with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and ServiceNow, see [this information page](https://cdn.cdata.com/help/BNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SharePoint
Source: https://docs.cloud.cdata.com/en/Data-Sources/SharePoint



## Setup Guide

Follow these steps to connect SharePoint to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SharePoint* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the base **URL** for the SharePoint site (for example, `https://teams.contoso.com`).
  </Step>

  <Step>
    Select the **Share Point Edition** from the drop down.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Select REST or SOAP from the **Schema** drop-down list.
      </Step>

      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the SharePoint sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your SharePoint account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzurePassword">
    <Steps>
      <Step>
        Enter your **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id found on the Overview page of the OAuth app used to authenticate to Microsoft SharePoint on Azure.
      </Step>

      <Step>
        Select REST or SOAP from the **Schema** drop-down list.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth JWT">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id found on the Overview page of the OAuth app used to authenticate to Microsoft SharePoint on Azure.
      </Step>

      <Step>
        Enter your **OAuth JWT certificate**. This is multi-line and in PEM format.
      </Step>

      <Step>
        Select the **OAuth JWT Cert type**.
      </Step>

      <Step>
        Enter the **OAuth JWT Issuer**. This should be set to the OAuth client Id.
      </Step>

      <Step>
        Select REST or SOAP from the **Schema** drop-down list.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the PingFederate **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Domain** to connect to.
      </Step>

      <Step>
        Select REST or SOAP from the **Schema** drop-down list.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Domain** to connect to.
      </Step>

      <Step>
        Select REST or SOAP from the **Schema** drop-down list.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OneLogin">
    <Steps>
      <Step>
        Enter the OneLogin **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Domain** to connect to.
      </Step>

      <Step>
        Select REST or SOAP from the **Schema** drop-down list.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Domain** to connect to.
      </Step>

      <Step>
        Select REST or SOAP from the **Schema** drop-down list.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SharePoint, see [this information page](https://cdn.cdata.com/help/RSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# ShipStation
Source: https://docs.cloud.cdata.com/en/Data-Sources/ShipStation



## Setup Guide

Follow these steps to connect ShipStation to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *ShipStation* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your ShipStation **API Secret** and **API Key**. These can be found in your ShipStation account under **API Settings**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and ShipStation, see [this information page](https://cdn.cdata.com/help/HSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Shopify
Source: https://docs.cloud.cdata.com/en/Data-Sources/Shopify



## Setup Guide

Follow these steps to connect Shopify to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Shopify* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the full URL of your shop into the **Shop URL** field (for example, *[https://yourshopname.myshopify.com](https://yourshopname.myshopify.com)*).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.

    <Warning>
      Starting January 1, 2026, you cannot create new applications with the **Access Token** authentication method. However, you can still use existing access token connections.
    </Warning>
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Note>
      * You can only use OAuth if you have a Partner app published on the Shopify store.
      * The Partner app must have *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)* registered as a redirect URI.
      * If you do not have a Partner app, you must create a custom OAuth app and use the **OAuthClient** authentication scheme.
    </Note>

    Follow these steps in Connect AI:

    <Steps>
      <Step>
        In **OAuth Client Id**, enter the Client Id from your Partner app.
      </Step>

      <Step>
        In **OAuth Client Secret**, enter your Client Secret from your Partner app.
      </Step>

      <Step>
        Select the Shopify **Schema** you want to use from drop-down list.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Shopify sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Shopify account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    This authentication requires a custom OAuth app. To register a custom app and obtain the **OAuth Client Id** and **OAuthClientSecret**, follow these steps:

    <Steps>
      <Step>
        Log in to the **Shopify Dev Dashboard**.
      </Step>

      <Step>
        Select **Apps** > **Create app**.
      </Step>

      <Step>
        Enter a name for the application and click **Create**.
      </Step>

      <Step>
        In the **Access** section, specify the required scopes and three redirect URLs: *[http://localhost:33333](http://localhost:33333)*, *[https://localhost/](https://localhost/)*, and *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Click **Release**. Optionally enter a name and message for the version and click **Release** again.
      </Step>

      <Step>
        Select the **Settings** tab to view and record the Client Id and Client Secret.
      </Step>

      <Step>
        Select the **Home** tab. From here, you can optionally install the app on a specific store or select a distribution method.
      </Step>
    </Steps>

    You can now enter the **Client Id** and **Client Secret** in Connect AI.

    <Steps>
      <Step>
        In **OAuth Client Id**, enter the Client Id from your custom OAuth app.
      </Step>

      <Step>
        In **OAuth Client Secret**, enter your Client Secret from your custom OAuth app.
      </Step>

      <Step>
        Select the Shopify **Schema** you want to use from the drop-down list.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AccessToken">
    <Note>
      This authentication scheme is deprecated. However, you can still enter an **Access Token** for existing applications.
    </Note>

    <Steps>
      <Step>
        Enter the **Access Token** from your existing application.
      </Step>

      <Step>
        Select the Shopify **Schema** you want to use from the drop-down list.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Shopify, see [this information page](https://cdn.cdata.com/help/FOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SingleStore
Source: https://docs.cloud.cdata.com/en/Data-Sources/SingleStore



## Setup Guide

Follow these steps to connect SingleStore to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SingleStore* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **User**—the SingleStore username for authentication
    * **Password**—the user password
    * **Port**—the port for connecting to the SingleStore server
    * **Server**—the host name or IP address of the SingleStore server
    * **Database**—the name of the SingleStore database
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SingleStore, see [this information page](https://cdn.cdata.com/help/JMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Slack
Source: https://docs.cloud.cdata.com/en/Data-Sources/Slack



## Setup Guide

Follow these steps to connect Slack to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Slack* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Slack sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Slack account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Slack, see [this information page](https://cdn.cdata.com/help/FCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Smaregi
Source: https://docs.cloud.cdata.com/en/Data-Sources/Smaregi



## Setup Guide

Follow these steps to connect Smaregi to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Smaregi* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Access Token**—the access token for the Smaregi user.
    * **Contract Id**—the contract Id for the Smaregi user.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Smaregi, see [this information page](https://cdn.cdata.com/help/UXM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Smartsheet
Source: https://docs.cloud.cdata.com/en/Data-Sources/Smartsheet



## Setup Guide

Follow these steps to connect Smartsheet to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Smartsheet* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="PersonalAccessToken">
    <Steps>
      <Step>
        Enter your **Personal Access Token**. You can get your token in your Smartsheet Account by navigating to **Account > Personal Settings > API Access** and using the provided form to generate it.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Smartsheet account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Smartsheet account for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Smartsheet, see [this information page](https://cdn.cdata.com/help/BSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Snapchat Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/SnapchatAds



## Setup Guide

Follow these steps to connect Snapchat Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Snapchat Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Snapchat Ads **Account Id** (optional).
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Snapchat Ads sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Snapchat Ads account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Snapchat Ads, see [this information page](https://cdn.cdata.com/help/JPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Snowflake
Source: https://docs.cloud.cdata.com/en/Data-Sources/Snowflake



## Prerequisites

#### Whitelist CData IPs

To establish a connection to Snowflake, you need to allow access to Snowflake via CData’s IP. When hosting Snowflake behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure Snowflake Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect Snowflake to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Snowflake* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the Snowflake **Warehouse**.
  </Step>

  <Step>
    Enter the **URL** of the Snowflake database. Snowflake supports URLs in either the account name or connection name format.

    * To use the account name, refer to [Finding the organization and account name for an account](https://docs.snowflake.com/en/user-guide/admin-account-identifier#label-account-name-find) in the Snowflake documentation.
    * To use the connection name, use the [SHOW CONNECTIONS](https://docs.snowflake.com/en/sql-reference/sql/show-connections) command.
      The URL format depends on how you are connecting. Refer to the [Connecting with a URL](https://docs.snowflake.com/en/user-guide/organizations-connect#connecting-with-a-url) in the Snowflake documentation for help in entering the URL correctly.
      The following are a few examples of formatting the URL:
    * Standard URL with account name: `https://<orgname>-<account_name>.snowflakecomputing.com`.
    * Standard URL with connection name: `https://<orgname>-<connectionname>.snowflakecomputing.com`.
    * Okta SSO: `https://<orgname>-<account-name>.snowflakecomputing.com` (if your account name contains an underscore, change the underscore to a hyphen).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>

  <Step>
    Under **Authentication Model**, determine if you want to allow shared authentication or require users to use their own credentials (per-user authentication).
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        In the **User** field, enter your Snowflake user name.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Snowflake account.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Snowflake account for OAuth.
      </Step>

      <Step>
        Select the **OAuth Authenticator** that the OAuth application requests from Snowflake. If there is no authenticator, use the default **None**.
      </Step>

      <Step>
        (Optional) Enter the Snowflake **Database** and **Schema**. Selecting a schema may improve performance for some applications.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Snowflake sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Snowflake account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Password">
    <Info>
      **Important:** Any new Snowflake account starting with bundle "2024\_08" will no longer support Password authentication. Please use other authentication methods, such as OAuth or Private Key.
    </Info>

    <Steps>
      <Step>
        Enter your user name in the **User** field and password in the **Password** field.
      </Step>

      <Step>
        In the **Database** section, enter the name of the Snowflake database to connect to.
      </Step>

      <Step>
        (Optional) Enter the schemas of the Snowflake database to connect to. If this is left blank, the connector has access to all schemas in the database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Snowflake, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Private Key">
    Follow these steps to configure private key authentication:

    <Steps>
      <Step>
        Open your Snowflake keyfile (which ends in .p8) in a text editor.
      </Step>

      <Step>
        Copy the entire contents of the file.
      </Step>

      <Step>
        Enter the copied contents of your private key into the **Private Key** field.
      </Step>

      <Step>
        If your private key has a password, enter it in the **Private Key Password** field.
      </Step>

      <Step>
        Select the correct **Private Key Type** from the drop down.
      </Step>

      <Step>
        In the **Database** section, enter the name of the Snowflake database to connect to.
      </Step>

      <Step>
        (Optional) Enter the schemas of the Snowflake database to connect to. If this is left blank, the connector has access to all schemas in the database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Snowflake, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the following information:

        * **User**— The Okta user account.
        * **Password**— The password associated with the Okta account.
        * **MFA Passcode**— Set this to the OTP code that was sent to your device. This property should be used only when Multi-Factor Authentication is required for Okta sign on.
        * **SSO Properties**— are needed to authenticate to Okta:
          * Domain: Set this to the Okta org domain name.
          * MFAType (optional): Set this to the multi-factor type. This property should be used only when the MFA is required for Okta sign on. This property accepts one of the following values:
            * OktaVerify
            * Email
            * SMS
          * APIToken (optional): Set this to the API Token created by Okta. This is used when authenticating a user via a trusted application or proxy that overrides the Okta client request context.
      </Step>

      <Step>
        In the **Database** section, enter the name of the Snowflake database to connect to.
      </Step>

      <Step>
        (Optional) Enter the schemas of the Snowflake database to connect to. If this is left blank, the connector has access to all schemas in the database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Snowflake, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        In the **User** field, enter the Snowflake username for authentication.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        (Optional) Enter the **Proof Key**. You must specify this if you want to connect to PingFederate without using a browser.
      </Step>

      <Step>
        (Optional) Enter the **External Token**. You must specify this if you want to connect to PingFederate without using a browser. For more information about the Proof Key and External Token, follow the steps [here](https://cdn.cdata.com/help/OWJ/cloud/default.htm#RSBSnowflake_p_AuthScheme).
      </Step>

      <Step>
        (Optional) Enter the **Database** and **Schema**. Selecting a schema may improve performance for some applications.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Private Cloud Connector Connection

Snowflake is a supported connector with Private Cloud Connector, which acts as a bridge between your on-premises data and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information. Once you set up the gateway, you can select the **Connection Type** of **Private Cloud Connector**. Then enter **Location Name** of the gateway and the Snowflake authentication information.

## More Information

For more information about interactions between Connect AI and Snowflake, see [this information page](https://cdn.cdata.com/help/OWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Spark SQL
Source: https://docs.cloud.cdata.com/en/Data-Sources/SparkSQL



## Setup Guide

Follow these steps to connect Spark SQL to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Spark SQL* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the **Server** hosting the Spark SQL database.
  </Step>

  <Step>
    In the **User** field, enter the Spark SQL username for authentication.
  </Step>

  <Step>
    Enter the user password in the **Password** field.
  </Step>

  <Step>
    Enter the port for connecting to the Spark SQL server in the **Port**. `10000` is the default value.
  </Step>

  <Step>
    Enter the name of the SparkSQL **Database**.
  </Step>

  <Step>
    In Spark SQL, add the Connect AI static IP addresses to your connection whitelist.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Spark SQL, see [this information page](https://cdn.cdata.com/help/ESM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Splunk
Source: https://docs.cloud.cdata.com/en/Data-Sources/Splunk



## Setup Guide

Follow these steps to connect Splunk to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Splunk* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** to your Splunk endpoint.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        In the **User** field, enter the Splunk username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Access Token">
    <Steps>
      <Step>
        Enter your **Access Token**. You can find your token on the Users and Authentications page of the Splunk UI.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="HTTP Event Collector Token">
    <Note>This authentication scheme is only used for a single Splunk stored procedure: CreateHTTPEvent. In order for this authentication scheme to work correctly, the IPs of either your computer or Connect AI need to be whitelisted on the Splunk side.</Note>

    <Steps>
      <Step>
        Enter your **HTTP Event Collector Token**. You can find your token on the **Data Inputs > HTTP Event Collector Token** page of the Splunk UI.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Splunk, see [this information page](https://cdn.cdata.com/help/FUM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Square
Source: https://docs.cloud.cdata.com/en/Data-Sources/Square



## Setup Guide

Follow these steps to connect Square to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Square* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) To set a business location as default, enter the Id in the **Location Id** field. Otherwise, leave this field blank.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Square sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Square account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Square, see [this information page](https://cdn.cdata.com/help/CRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Stripe
Source: https://docs.cloud.cdata.com/en/Data-Sources/Stripe



## Setup Guide

Follow these steps to connect Stripe to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Stripe* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Stripe sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Stripe account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIKey">
    <Steps>
      <Step>
        Enter your **Live API Key**. To find your key, navigate to **Developers > API Keys > Secret key** in your Stripe account and click `Reveal Live API Key`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Stripe, see [this information page](https://cdn.cdata.com/help/BOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Sugar CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/SugarCRM



## Setup Guide

Follow these steps to connect Sugar CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Sugar CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of the Sugar CRM account.
  </Step>

  <Step>
    In the **User** field, enter the Sugar CRM username for authentication.
  </Step>

  <Step>
    Enter the user password in the **Password** field.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Sugar CRM, see [this information page](https://cdn.cdata.com/help/CCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SuiteCRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/SuiteCRM



## Prerequisites

The SuiteCRM V8 API uses OAuth for authentication, so the **OAuthClient** and **OAuthPassword** authentication methods require a custom OAuth application. If you are connecting to the SuiteCRM V4.1 API with the **Basic** authentication method, you can skip this section.

A SuiteCRM administrator must create and register the custom OAuth application. To create a custom OAuth application in SuiteCRM, follow these steps:

<Steps>
  <Step>
    Log in to your SuiteCRM account with administrative credentials.
  </Step>

  <Step>
    In the **Profile** dropdown, select **Admin > OAuth2 Clients and Tokens**.
  </Step>

  <Step>
    Click **New Client Credentials Client** (for the **OAuthClient** method) or **New Password Client** (for the **OAuthPassword** method).
  </Step>

  <Step>
    Enter a **Name** and a **Secret** for the application, then click **Save**.
  </Step>

  <Step>
    Retrieve the generated client ID and client secret. You enter these values as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>
</Steps>

<Note>
  Users who authenticate with the **OAuthClient** (client credentials) grant type have full access to the API. Users who authenticate with the **OAuthPassword** grant type require permissions for each module or table they access.
</Note>

## Setup Guide

Follow these steps to connect SuiteCRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SuiteCRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of your SuiteCRM account, for example *[http://your-suitecrm-instance.com](http://your-suitecrm-instance.com)*.
  </Step>

  <Step>
    Select the **Schema** that matches your SuiteCRM API version: **suitecrmv4** for the SuiteCRM V4.1 API or **suitecrmv8** for the SuiteCRM V8 API.
  </Step>

  <Step>
    Select the **Auth Scheme** to use when connecting to SuiteCRM, then follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Confirm that the **Schema** is set to **suitecrmv4**. The **Basic** authentication method is supported only for the SuiteCRM V4.1 API.
      </Step>

      <Step>
        Enter the **User**, the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password** for that user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Confirm that the **Schema** is set to **suitecrmv8**. The **OAuthClient** authentication method is supported only for the SuiteCRM V8 API.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Confirm that the **Schema** is set to **suitecrmv8**. The **OAuthPassword** authentication method is supported only for the SuiteCRM V8 API.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **User**, the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password** for that user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SuiteCRM, see [this information page](https://cdn.cdata.com/help/ETM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SurveyMonkey
Source: https://docs.cloud.cdata.com/en/Data-Sources/SurveyMonkey



## Setup Guide

Follow these steps to connect SurveyMonkey to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SurveyMonkey* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the SurveyMonkey sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your SurveyMonkey account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AccessToken">
    <Steps>
      <Step>
        Enter your **Access Token**. You can obtain this by creating an OAuth app in SurveyMonkey.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SurveyMonkey, see [this information page](https://cdn.cdata.com/help/FMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Sybase
Source: https://docs.cloud.cdata.com/en/Data-Sources/Sybase



## Setup Guide

Follow these steps to connect Sybase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Sybase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the name of the **Server** running the Sybase database.
  </Step>

  <Step>
    Enter the **Port** of the Sybase database. The default value is **5000**.
  </Step>

  <Step>
    (Optional) Enter the name of the Sybase **Database** running on the specified **Server**.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    **Password** authenticates using a Sybase user Id and password.

    <Steps>
      <Step>
        Enter the **User** Id of the authenticating user.
      </Step>

      <Step>
        Enter the **Password** of the authenticating user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Kerberos">
    **Kerberos** authenticates using the Kerberos protocol.

    <Steps>
      <Step>
        No additional settings are required for this authentication method.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Sybase, see [this information page](https://cdn.cdata.com/help/OYM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SybaseIQ
Source: https://docs.cloud.cdata.com/en/Data-Sources/SybaseIQ



## Setup Guide

Follow these steps to connect SybaseIQ to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SybaseIQ* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the name of the **Server** running the SybaseIQ or SAP SQL Anywhere database instance.
  </Step>

  <Step>
    Enter the **Port** number of the SybaseIQ or SAP SQL Anywhere database.
  </Step>

  <Step>
    Enter the name of the SybaseIQ or SAP SQL Anywhere **Database** running on the specified server.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

### Password

<Steps>
  <Step>
    Enter the **User** Id for the authenticating user.
  </Step>

  <Step>
    Enter the **Password** for the authenticating user.
  </Step>

  <Step>
    Enter the **Connection Type** of either **SybaseIQ** or **SQLAnywhere**.
  </Step>

  <Step>
    (Optional) Enter the **SSL Server Cert** when connecting using TLS/SSL.
  </Step>

  <Step>
    Toggle **Use SSL** to enable SSL. For SybaseIQ, SSL is available only when the server version is 16.1 or higher.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SybaseIQ, see [this information page](https://cdn.cdata.com/help/GYM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Talkdesk
Source: https://docs.cloud.cdata.com/en/Data-Sources/Talkdesk



## Prerequisites

Before you can connect to Connect AI, you must create an OAuth client in Talkdesk Partner Project.

<Steps>
  <Step>
    Go to [account.talkdeskid.com/select/atlas/apps/oauth-clients](https://account.talkdeskid.com/select/atlas/apps/oauth-clients) and log in.
  </Step>

  <Step>
    Click **Create OAuth Client**.
  </Step>

  <Step>
    Enter a name for the OAuth client and select **Client Credentials** as the grant type.
  </Step>

  <Step>
    Add the required scopes. For the full list of available scopes, see the [Talkdesk scopes documentation](https://docs.talkdesk.com/docs/scopes).
  </Step>

  <Step>
    Click **Download** or copy the **Client ID** and **Client Secret** values. You enter these values in Connect AI.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Talkdesk to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Talkdesk* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Talkdesk **Account Name**.
  </Step>

  <Step>
    Enter the **OAuth Client Id** that you obtained in the prerequisites.
  </Step>

  <Step>
    Enter the **OAuth Client Secret** that you obtained in the prerequisites.
  </Step>

  <Step>
    Select the **Region** where your Talkdesk service is located (US, EU, CA, AU, UK, or FedRamp).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Tally
Source: https://docs.cloud.cdata.com/en/Data-Sources/Tally



## Setup Guide

Follow these steps to connect Tally to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Tally* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of your Tally instance, in the format `http://{hostname or server ip}:9000`. For example: `http://windows-a5.cloud.com:9000`.
  </Step>

  <Step>
    (Optional) Enter the **Company** name in Tally that you want to retrieve data from.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Tally, see [this information page](https://cdn.cdata.com/help/HTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# TaxJar
Source: https://docs.cloud.cdata.com/en/Data-Sources/TaxJar



## Prerequisites

Before you can add the connection, you must generate an API key from your TaxJar account:

<Steps>
  <Step>
    Log in to your TaxJar dashboard and click your **Account** menu in the top-right corner.
  </Step>

  <Step>
    Select **TaxJar API** from the drop-down list.
  </Step>

  <Step>
    Click **Generate Token** to create your API key and copy it. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect TaxJar to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *TaxJar* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    (Optional) Toggle on **Use Sandbox** to connect to the TaxJar sandbox environment instead of production.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and TaxJar, see [this information page](https://cdn.cdata.com/help/JTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Teradata
Source: https://docs.cloud.cdata.com/en/Data-Sources/Teradata



## Setup Guide

Follow these steps to connect Teradata to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Teradata* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Data Source**, which is the Teradata server name, DBC Name, or TDPID.
  </Step>

  <Step>
    Enter the **User** and **Password** for your Teradata account.
  </Step>

  <Step>
    Select the **Auth Scheme**: **TD2** (Teradata native authentication) or **LDAP** (authenticate through an LDAP directory).
  </Step>

  <Step>
    (Optional) Enter the **Database** to use as the default database for the connection.
  </Step>

  <Step>
    (Optional) Enter the **Port**. The default Teradata port is 1025.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Teradata, see [this information page](https://cdn.cdata.com/help/OTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# TigerGraph
Source: https://docs.cloud.cdata.com/en/Data-Sources/TigerGraph



## Prerequisites

If you plan to authenticate with the **Secret** method, generate a TigerGraph secret before you begin:

<Steps>
  <Step>
    Log in to TigerGraph and open the **Admin Portal** (TigerGraph Cloud) or **GraphStudio** (TigerGraph Server).
  </Step>

  <Step>
    Go to **User Management** and select the **My Profile** tab.
  </Step>

  <Step>
    Scroll to the secrets section and click the plus sign (**+**) to create a new secret.
  </Step>

  <Step>
    Enter an alias for the secret, then generate it.
  </Step>

  <Step>
    Copy the secret value and save it in a secure location. After you leave or refresh the page, the value is masked and cannot be retrieved again.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect TigerGraph to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *TigerGraph* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of the server where your TigerGraph instance is hosted.
  </Step>

  <Step>
    Select the **Tiger Graph Edition** being used: **TigerGraph Cloud** or **TigerGraph Server**.
  </Step>

  <Step>
    (Optional) Enter the **Port** of the TigerGraph Server. The default port is 443.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Secret">
    <Steps>
      <Step>
        Enter the **Secret**, which is the TigerGraph secret used to authenticate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Trello
Source: https://docs.cloud.cdata.com/en/Data-Sources/Trello



## Setup Guide

Follow these steps to connect Trello to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Trello* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Trello account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Trello account for OAuth.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Trello sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Trello account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the **API Key** for your Trello account. You can access this by logging into your Trello account and visiting `https://trello.com/app-key`.
      </Step>

      <Step>
        Enter your Trello **Token**, which is found on the same page as the API Key.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Trello, see [this information page](https://cdn.cdata.com/help/UTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Twilio
Source: https://docs.cloud.cdata.com/en/Data-Sources/Twilio



## Setup Guide

Follow these steps to connect Twilio to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Twilio* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Log in to your Twilio account.
  </Step>

  <Step>
    Select **Account > Account Settings** (on your account dashboard) to obtain your account credentials.
  </Step>

  <Step>
    Return to Connect AI.
  </Step>

  <Step>
    Enter the following information:

    * **Account SID**—the account SID of the current Twilio user
    * **Auth Token**—the auth token of the current Twilio user
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Twilio, see [this information page](https://cdn.cdata.com/help/BTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Twitter Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/TwitterAds



## Prerequisites

Before you can connect to Connect AI, you must create OAuth client credentials in Twitter Ads.

<Steps>
  <Step>
    Log in to [https://developer.twitter.com/en/portal/projects-and-apps](https://developer.twitter.com/en/portal/projects-and-apps).
  </Step>

  <Step>
    Create a new Project in the Developer Portal.
  </Step>

  <Step>
    At the project you just created, click **Add App**.
  </Step>

  <Step>
    Set a name for the Application. Twitter Ads displays your keys and tokens.
  </Step>

  <Step>
    Record the values of the **Consumer Key** and **Consumer Secret**. You will need them for the **Client Id** and **Client Secret** on the **Add Twitter Ads Connection** page.
  </Step>

  <Step>
    Navigate to the **User Application settings** and click **Set up**.
  </Step>

  <Step>
    Turn on the 'OAuth 1.0a' authentication.
  </Step>

  <Step>
    From the available Application permissions, select **Read and write** and **Direct message**.
  </Step>

  <Step>
    Specify the URL of the website and other optional information to be displayed to users when they connect.
  </Step>

  <Step>
    Set the Callback URL (also known as the Redirect URL) to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Twitter Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Twitter Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    For **OAuth Client Id**, enter the **Consumer Key** obtained from the prerequisites.
  </Step>

  <Step>
    For **OAuth Client Secret**, enter the **Consumer Secret** obtained from the prerequisites.
  </Step>

  <Step>
    (Optional) Enter your **Account Id** if you want to restrict your connection to a specific account.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Twitter Ads sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Twitter Ads account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Twitter Ads, see [this information page](https://cdn.cdata.com/help/HMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# UM SaaS Cloud
Source: https://docs.cloud.cdata.com/en/Data-Sources/UMSaaSCloud



## Prerequisites

The **OAuth**, **OAuthClient**, **OAuthPassword**, and **AzureAD** authentication methods require a custom OAuth application. The default **OAuthPKCE** method uses CData's embedded OAuth application, so you can skip this section if you are using it.

To create a custom OAuth application in UM SaaS Cloud, follow these steps:

<Steps>
  <Step>
    Log in to your Salesforce org (the org where UM SaaS Cloud is installed) and navigate to **Setup**. In the **Quick Find** box, search for *Apps*, then click **New Connected App**.
  </Step>

  <Step>
    Enter a **Connected App Name** (the display name shown on the authentication dialog) and a **Contact Email**.
  </Step>

  <Step>
    Under **API (Enable OAuth Settings)**, select **Enable OAuth Settings** and set the **Callback URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Select the **OAuth scopes** that your application should request from the user, then **Save** the application.
  </Step>

  <Step>
    Open the connected app's settings to retrieve the **Consumer Key** (your **OAuth Client Id**) and **Consumer Secret** (your **OAuth Client Secret**). You enter these values in Connect AI when configuring the connection.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect UM SaaS Cloud to your Connect AI account:

<Steps>
  <Step>
    On the **Basic Settings** tab of the UM SaaS Cloud connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the UM SaaS Cloud sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your UM SaaS Cloud account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the UM SaaS Cloud username for authentication.
      </Step>

      <Step>
        Enter the user **Password**.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the UM SaaS Cloud sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your UM SaaS Cloud account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the UM SaaS Cloud username for authentication.
      </Step>

      <Step>
        Enter the user **Password**.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT Cert**. This is multi-line and in PEM format.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT Certificate.
      </Step>

      <Step>
        Enter the **OAuth JWT Issuer**. This must include the client\_id or connected app for which the certificate is registered.
      </Step>

      <Step>
        (Optional) Enter an **OAuth JWT Cert Password**. If the certificate store does not require a password, leave this field blank.
      </Step>

      <Step>
        (Optional) Enter an **OAuth JWT Cert Subject**, which identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. The wildcard '\*' selects the first certificate.
      </Step>

      <Step>
        (Optional) **OAuth JWT Subject** contains the user subject for which the application is requesting delegated access. It is only required if you are implementing for an Experience Cloud site.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OneLogin">
    <Steps>
      <Step>
        Enter the OneLogin **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the UM SaaS Cloud account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint under your organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the PingFederate **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the UM SaaS Cloud account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint under your organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the UM SaaS Cloud account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint under your organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the UM SaaS Cloud account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint under your organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the UM SaaS Cloud account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint under your organization.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the UM SaaS Cloud sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your UM SaaS Cloud account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Veeva Vault
Source: https://docs.cloud.cdata.com/en/Data-Sources/VeevaVault



## Setup Guide

Follow these steps to connect Veeva Vault to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Veeva Vault* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Veeva Vault **URL**. This follows the format `https://vaultname.veevavault.com`.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Veeva Vault username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureADOpenID">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        (Optional) Enter the **OpenID Connect Profile ID**. This can be found in your OAuth 2.0 or OpenID Connect Profile settings.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Veeva Vault, see [this information page](https://cdn.cdata.com/help/SVM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Vertica
Source: https://docs.cloud.cdata.com/en/Data-Sources/Vertica



## Setup Guide

Follow these steps to connect Vertica to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Vertica* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Server**—the host name or IP address of the Vertica server.
    * **Port**—the port of the server hosting the Vertica database.
    * **User**—the authenticating user's user Id.
    * **Password**—the authenticating user's password.
    * **Database**—the name of the Vertica database.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Wave Financial
Source: https://docs.cloud.cdata.com/en/Data-Sources/WaveFinancial



## Prerequisites

Register a Wave Financial application if you want to use a custom OAuth application, or if you want to connect using the Token auth scheme, which requires an API token generated from a registered application.

To register an application and obtain its credentials, follow these steps:

<Steps>
  <Step>
    Log in to your Wave Financial account, then go to the Wave developer apps portal: [https://developer-apps.waveapps.com/apps/](https://developer-apps.waveapps.com/apps/).
  </Step>

  <Step>
    Click **Create an application** and fill in your application details. Set the redirect URI to the CData callback URL: *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    After you create the application, retrieve the **Client Id** and **Client Secret**. If you are using a custom OAuth application, you enter these values as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>

  <Step>
    To use the Token auth scheme, click **Create token** on your application to generate an **API Token**. You enter this value in the setup steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Wave Financial to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Wave Financial* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Auth Scheme** to use when connecting to Wave Financial, then follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        If you are using a custom OAuth application, click **Advanced Settings** and enter the **OAuth Client Id** and **OAuth Client Secret** assigned to your application. You can also enter the **Scope** of the authenticating user's access to the application.
      </Step>

      <Step>
        Click **Sign in** to authenticate with Wave Financial. This action opens the Wave Financial sign-in page in a new tab.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the **API Token** obtained when you registered a Wave Financial application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Wave Financial, see [this information page](https://cdn.cdata.com/help/HWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# WooCommerce
Source: https://docs.cloud.cdata.com/en/Data-Sources/WooCommerce



## Setup Guide

Follow these steps to connect WooCommerce to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *WooCommerce* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of the WooCommerce instance to connect to
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the WooCommerce username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your WooCommerce account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your WooCommerce account for OAuth.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the WooCommerce sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your WooCommerce account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthOneLegged">
    <Steps>
      <Step>
        Enter your **Consumer Key**. This is generated on the WooCommerce **Settings** page.
      </Step>

      <Step>
        Enter the corresponding **Consumer Secret**. This is also generated on the WooCommerce **Settings** Page.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and WooCommerce, see [this information page](https://cdn.cdata.com/help/UZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# WordPress
Source: https://docs.cloud.cdata.com/en/Data-Sources/WordPress



## Setup Guide

Follow these steps to connect WordPress to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *WordPress* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your WordPress **URL**. This follows the format `https://www.yourwordpresssite.com`.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the WordPress username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your WordPress account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your WordPress account for OAuth.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the WordPress sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your WordPress account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and WordPress, see [this information page](https://cdn.cdata.com/help/FWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Workday
Source: https://docs.cloud.cdata.com/en/Data-Sources/Workday



## Setup Guide

Follow these steps to connect Workday to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Workday* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set your **Connection Type** from the drop-down list.

    * **WQL**—this connection exposes Workday data sources as read-only views using the Workday Query Language (WQL) service.
    * **Reports**—this connection exposes Workday reports as views using Reports as a Service (RaaS). The Reports connection has an additional **Custom Report URL** field. Enter the URL of the report that shows all Reports as a Service (RaaS) reports.
    * **REST**—this connection exposes Workday data as tables and views using the REST API.
    * **SOAP**—this connection exposes Workday data as views using the SOAP API.
  </Step>

  <Step>
    Choose an **Auth Scheme** for your connection type and follow the instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    To connect Workday to Connect AI using OAuth, you must first create an OAuth app in Workday. [Create an OAuth app in Workday](#create-an-oauth-app-in-workday) shows how to create a standard OAuth app. For other types of OAuth custom apps, refer to [this information page](https://cdn.cdata.com/help/JWM/cloud/default.htm#pg_connectiondatahubh).

    The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you register your application with an OAuth authorization server.
        * **OAuth Client Secret**—the client secret assigned when you register your application with an OAuth authorization server.
        * **Base URL**—the base URL for the Workday connection. To obtain the Base URL, log in to Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example, in the URL `https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources`, `https://wd3-impl-services1.workday.com` is the Base URL.
        * **Tenant**—the tenant for the account. The tenant is found in your Tenant Setup page in Workday. It is used when constructing a URL to retrieve data from Workday. For example, in the URL `https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources`, `mycompany_gms1` is the tenant.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Workday sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Workday account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthISU">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you register your application with an OAuth authorization server.
        * **OAuth Client Secret**—the client secret assigned when you register your application with an OAuth authorization server.
        * **OAuth Refresh Token**—the refresh token for the corresponding OAuth access token. Set up an OAuth Refresh Token if authenticating with Integration System Users (ISUs).
        * **Base URL**—the base URL for the Workday connection. To obtain the Base URL, log in to Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example, in the URL `https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources`, `https://wd3-impl-services1.workday.com` is the Base URL.
        * **Tenant**—the tenant for the account. The tenant is found in your Tenant Setup page in Workday. It is used when constructing a URL to retrieve data from Workday. For example, in the URL `https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources`, `mycompany_gms1` is the tenant.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you register your application with an OAuth authorization server.
        * **OAuth Client Secret**—the client secret assigned when you register your application with an OAuth authorization server.
        * **OAuth JWT Cert**—the contents of the JWT certificate file. An sample format is provided.
        * **OAuth JWT Cert Type**—the type of key store containing the JWT certificate. Select the type from the drop-down list.
        * **OAuth JWT Issuer**—the issuer of the Java Web Token. This is typically either the client Id or the email address of the OAuth application.
        * **OAuth JWT Subject**—the user subject for which the application is requesting delegated access. This is typically either the user account name or email address.
        * **OAuth JWT Cert Password**—(optional) the password for the OAuth JWT certificate. Enter a password if the certificate store requires it.
        * **OAuth JWT Cert Subject**—(optional) the subject of the OAuth JWT certificate. If omitted, the first certificate in the certificate store is used.
        * **Base URL**—the base URL for the Workday connection. To obtain the Base URL, log in to Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example, in the URL `https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources`, `https://wd3-impl-services1.workday.com` is the Base URL.
        * **Tenant**—the tenant for the account. The tenant is found in your Tenant Setup page in Workday. It is used when constructing a URL to retrieve data from Workday. For example, in the URL `https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources`, `mycompany_gms1` is the tenant.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

    <Steps>
      <Step>
        Enter the following information:

        * **SSO Properties**—additional properties required to connect to the identity provider in a semicolon-separated list.
        * **OAuth Client Id**—the client Id assigned when you register your application with an OAuth authorization server.
        * **Base URL**—the base URL for the Workday connection. To obtain the Base URL, log in to Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example, in the URL `https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources`, `https://wd3-impl-services1.workday.com` is the Base URL.
        * **Tenant**—the tenant for the account. The tenant is found in your Tenant Setup page in Workday. It is used when constructing a URL to retrieve data from Workday. For example, in the URL `https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources`, `mycompany_gms1` is the tenant.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Workday sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Workday account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic (SOAP Connection Type Only)">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Workday username for authentication
        * **Password**—the user password
        * **Base URL**—the base URL for the Workday connection. To obtain the Base URL, log in to Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example, in the URL `https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources`, `https://wd3-impl-services1.workday.com` is the Base URL.
        * **Tenant**—the tenant for the account. The tenant is found in your Tenant Setup page in Workday. It is used when constructing a URL to retrieve data from Workday. For example, in the URL `https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources`, `mycompany_gms1` is the tenant.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Create an OAuth App in Workday

OAuth connections to Workday require a custom OAuth application. Follow these steps to create a standard OAuth app:

<Steps>
  <Step>
    Login to your Workday account. In the search box at the top of the page, enter *Register API Client*.
  </Step>

  <Step>
    Select the **Register API Client** form.
  </Step>

  <Step>
    Enter a name for the app in the **Client Name** field.
  </Step>

  <Step>
    For the grant type, select **Authorization Code**.
  </Step>

  <Step>
    For the access token type, select **Bearer**.
  </Step>

  <Step>
    In the **Redirection URI** field, enter *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*
  </Step>

  <Step>
    In the **Scope** section, enable following scopes:

    * **Custom Objects** > **System**
    * **Custom Objects** > **Integration**
    * **Workday REST API** > **Tenant Non-Configurable**
  </Step>

  <Step>
    Enable any additional scopes that you require. If you are uncertain about which scopes to include, you can enable every scope under each subsection.
  </Step>

  <Step>
    Select the **Include Workday Owned Scope** checkbox.
  </Step>

  <Step>
    Click **OK** to save the app.
  </Step>

  <Step>
    Workday loads the View API Client page that contains information about the new app. Copy the **Client ID** and **Client Secret** for use in Connect AI.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Workday, see [this information page](https://cdn.cdata.com/help/JWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# XML
Source: https://docs.cloud.cdata.com/en/Data-Sources/XML



## Setup Guide

Follow these steps to connect XML to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *XML* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI** for the XML resource location.
  </Step>

  <Step>
    Select the **Data Model** to use when parsing XML documents. Options are as follows:

    * **Document**–returns a single table representing a row for each top-level object.
    * **FlattenedDocuments**–returns a single table representing a JOIN of the available documents in the file.
    * **Relational**–returns multiple tables for relational access to the data.
  </Step>

  <Step>
    (Optional) Enter the **XPath**, which is the XPath expression that defines which elements are modeled as rows. For multiple paths, provide a semicolon-separated list. If left blank, repeated elements in the XML document are detected automatically and modeled as rows.
  </Step>

  <Step>
    (Optional) Select the **XML Format** to use when parsing the XML files. Options are as follows:

    * **XML**–the default format, which should be used in the majority of cases. The element or attribute name containing each value is used as the column name for that value.
    * **XMLTable**–for when the column name is separate from the data contained in that column. This is useful when the element or attribute containing the data has a generic name (like "Value") instead of being specific to each column.
  </Step>

  <Step>
    Select the **Connection Type**, which specifies the file storage service, server, or file access protocol through which your XML files are stored and retrieved. Then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Connection Types

<Tabs>
  <Tab title="Amazon S3">
    <Steps>
      <Step>
        Select the **AWS Region** from the drop-down list. This is the hosting region for your Amazon Web Services.
      </Step>

      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme** to use when connecting to remote services. Then select the tab for your authentication scheme and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AwsRootKeys">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsEC2Roles">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsIAMRoles">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Role ARN**. This is the Amazon Resource Name of the role to use when authenticating.
          </Step>

          <Step>
            (Optional) Enter the **AWS External Id**. This is a unique identifier that might be required when you assume a role in another account.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsTempCredentials">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to AWS. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Session Token**. See the [AWS Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) for more information about the session token.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsCredentialsFile">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Keycloak">
        <Steps>
          <Step>
            Enter the **Keycloak Realm URL**. This specifies the full URL to the Keycloak server, including the specific realm used for authentication and authorization.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="EKSPodIdentity">
        <Steps>
          <Step>
            (Optional) Enter the **AWS Container Credentials Full URI**. This is the full URI of the container credential provider endpoint used by EKS Pod Identity.
          </Step>

          <Step>
            (Optional) Enter the **AWS Container Authorization Token File**. This is the path to a file containing the authorization token for the EKS Pod Identity credential provider.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Blob Storage">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2 SSL">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Files">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Box">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Dropbox">
    <Steps>
      <Step>
        (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTP">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTPS">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Google Cloud Storage">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Google Drive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS Secure">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTP">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTPS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="IBM Object Storage Source">
    <Steps>
      <Step>
        Enter the **Api Key** used to identify the user to the IBM Cloud.
      </Step>

      <Step>
        Enter the **Region**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from the security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneDrive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneLake">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Oracle Cloud Storage">
    <Steps>
      <Step>
        Enter the hosting **Region** for your S3-like Web Services.
      </Step>

      <Step>
        Enter the **Oracle Namespace**. This is the Oracle Cloud Object Storage namespace to use.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SFTP">
    <Steps>
      <Step>
        Select the **SSH Auth Mode**, which is the type of authentication to use when connecting to remote services. Then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Password">
        <Steps>
          <Step>
            Enter the **SSH User** used to authenticate to the SFTP server.
          </Step>

          <Step>
            Enter the **SSH Password** used to authenticate to the SFTP server.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Public_Key">
        <Steps>
          <Step>
            Enter the **SSH Client Cert**, which is the name of the certificate store for the client certificate.
          </Step>

          <Step>
            Select the **SSH Client Cert Type**, which is the type of key store containing the client certificate.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Password**. This is the password for the client certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Subject**. This is the subject of the SSH client certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the XML tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint SOAP">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST V1">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and XML, see [this information page](https://cdn.cdata.com/help/DVM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Xero
Source: https://docs.cloud.cdata.com/en/Data-Sources/Xero



## Setup Guide

Follow these steps to connect Xero to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Xero* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Xero **Schema** to connect to.
  </Step>

  <Step>
    (Optional) Set a Tenant Id to connect to. If left blank, the connection will use the first available tenant.
  </Step>

  <Step>
    Click **Connect to Xero** to open the Xero sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Xero account with your email address and password.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Xero, see [this information page](https://cdn.cdata.com/help/DXM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Yahoo! Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/YahooAds



## Setup Guide

Follow these steps to connect Yahoo! Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Yahoo! Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) Enter the **Search Ads Account Id**. If left blank, this defaults to the Authenticated user's primary account.
  </Step>

  <Step>
    (Optional) Enter the **Display Ads Account Id**. If left blank, this defaults to the Authenticated user's primary account.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Yahoo! Ads sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Yahoo! Ads account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Yahoo! Japan Data Solution
Source: https://docs.cloud.cdata.com/en/Data-Sources/YahooDS



## Setup Guide

Follow these steps to connect Yahoo! Japan Data Solution to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Yahoo! Japan Data Solution* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the application Id to use for authentication in the **App ID** field.
  </Step>

  <Step>
    (Optional) Enter a **Search Keyword**. You can specify any value to search for.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Yahoo! Japan Data Solution, see [this information page](https://cdn.cdata.com/help/JOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Yahoo Shopping
Source: https://docs.cloud.cdata.com/en/Data-Sources/YahooShopping



## Prerequisites

Before you can connect to Connect AI, you must create a custom OAuth application for Yahoo Shopping.

<Steps>
  <Step>
    Log in to Yahoo Developers Network.
  </Step>

  <Step>
    Access the Application Management site at `https://e.developer.yahoo.co.jp/`.
  </Step>

  <Step>
    Click **Create New Application**.
  </Step>

  <Step>
    Specify a name for the new application.
  </Step>

  <Step>
    Set the redirect URL to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save your changes.
  </Step>

  <Step>
    Enter the Client Id and Client Secret obtained here in the setup steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Yahoo Shopping to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Yahoo Shopping* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information obtained in the prerequisites:

    * **OAuth Client Id**—the client ID assigned to your custom OAuth application.
    * **OAuth Client Secret**—the client secret assigned to your custom OAuth application.
  </Step>

  <Step>
    (Optional) Enter the following information:

    * **Seller Id**—your store account ID.
    * **Public Key**—the public key shared by Yahoo Shopping.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Yahoo Shopping sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Yahoo Shopping account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Yahoo Shopping, see [this information page](https://cdn.cdata.com/help/OJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# YouTube Analytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/YouTubeAnalytics



## Setup Guide

Follow these steps to connect YouTube Analytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *YouTube Analytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        (Optional) Enter your **Content Owner Id** to generate content owner reports.
      </Step>

      <Step>
        (Optional) Enter your **Channel Id**. If left blank, the default channel of the Authenticated user is used.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the YouTube Analytics sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your YouTube Analytics account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        (Optional) Enter your **Content Owner Id** to generate content owner reports.
      </Step>

      <Step>
        (Optional) Enter your **Channel Id**. If left blank, the default channel of the Authenticated user is used.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and YouTube Analytics, see [this information page](https://cdn.cdata.com/help/BYM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zendesk
Source: https://docs.cloud.cdata.com/en/Data-Sources/Zendesk



## Prerequisites

Complete these steps to create an OAuth application before configuring the connection (OAuth and OAuthPKCE only):

<Steps>
  <Step>
    Log in to your Zendesk account using an account that has admin access.
  </Step>

  <Step>
    In the Zendesk Support admin interface, navigate to **Admin > Channels > API**.
  </Step>

  <Step>
    On the **Zendesk API** page, click the **OAuth Clients** tab.
  </Step>

  <Step>
    At the right side of the client list, click the plus icon (**+**).
  </Step>

  <Step>
    Complete the required fields to create a client, then set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Save**. After the page refreshes, a **Secret** field appears.
    <Note>When the Client kind of the OAuth application is set to **Confidential**, you must use **OAuth** authentication. When the Client kind of the OAuth application is set to **Public**, you must use **OAuthPKCE** authentication.</Note>
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Zendesk to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zendesk* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Zendesk Support **URL**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        In the **OAuth Client Id** field, enter the unique identifier from the prerequisites.
      </Step>

      <Step>
        In the **OAuth Client Secret** field, enter the secret from the prerequisites.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Zendesk sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Zendesk account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth with PKCE. This action opens the Zendesk sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Zendesk account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIToken">
    <Steps>
      <Step>
        In the **User** field, enter the Zendesk username for authentication.
      </Step>

      <Step>
        In the Zendesk Support admin interface, navigate to **Admin > Channels > API** and create an API token on the **Zendesk API** page.
      </Step>

      <Step>
        In the **API Token** field, enter the API token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Zendesk, see [this information page](https://cdn.cdata.com/help/FZK/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho Books
Source: https://docs.cloud.cdata.com/en/Data-Sources/ZohoBooks



## Setup Guide

Follow these steps to connect Zoho Books to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho Books* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select your **Region**.
  </Step>

  <Step>
    Enter your **Organization Id**. This can be found in your Zoho Books account settings.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho Books sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho Books account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Zoho Books, see [this information page](https://cdn.cdata.com/help/GZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/ZohoCRM



## Setup Guide

Follow these steps to connect Zoho CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho CRM sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho CRM account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    Select the CRM organization that you want to connect to Connect AI and click **Submit**.
  </Step>

  <Step>
    Click **Accept** to grant the requested access permissions. **Note:** Each permission is required for the connection to function.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Zoho CRM, see [this information page](https://cdn.cdata.com/help/CZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho Creator
Source: https://docs.cloud.cdata.com/en/Data-Sources/ZohoCreator



## Setup Guide

Follow these steps to connect Zoho Creator to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho Creator* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select your **Region**.
  </Step>

  <Step>
    (Optional) Fill out the **Schema** field with schemas of the databases to connect to in the database. If this is left blank, the connector has access to all schemas in the database.
  </Step>

  <Step>
    (Optional) Fill out the **Report Form Relations** field. This is in the following format:

    * MyReport1=Form1;MyReport2=Form2,Form3
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho Creator sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho Creator account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Zoho Creator, see [this information page](https://cdn.cdata.com/help/KCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho Inventory
Source: https://docs.cloud.cdata.com/en/Data-Sources/ZohoInventory



## Setup Guide

Follow these steps to connect Zoho Inventory to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho Inventory* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set your **Region**.
  </Step>

  <Step>
    (Optional) Enter your **Organization Id**. If not specified, the connection uses the first organization found.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho Inventory sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho Inventory account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zoho Projects
Source: https://docs.cloud.cdata.com/en/Data-Sources/ZohoProjects



## Setup Guide

Follow these steps to connect Zoho Projects to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zoho Projects* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set your **Region**.
  </Step>

  <Step>
    (Optional) Enter the **Project Id**. If left empty, all available projects are exposed.
  </Step>

  <Step>
    (Optional) Enter the **Portal Id**. If left empty, all available portals are exposed.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Zoho Projects sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Zoho Projects account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Zoho Projects, see [this information page](https://cdn.cdata.com/help/PZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Zuora
Source: https://docs.cloud.cdata.com/en/Data-Sources/Zuora



## Prerequisites

Before you can connect to Connect AI, you must create OAuth client credentials in Zuora.

<Steps>
  <Step>
    Using an account that has administration privileges for your Zuora tenant, log in to Zuora.
  </Step>

  <Step>
    Go to the **Profiles & Settings** menu and navigate to **Administration** > **Manage Users**.
  </Step>

  <Step>
    Create a user.
  </Step>

  <Step>
    Navigate to your Zuora tenant's **Users** page.
  </Step>

  <Step>
    Select the new user you just created, and then create an OAuth client for that user. Note the OAuth Client Id and OAuth Client Secret.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Zuora to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Zuora* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information.

    * **OAuth Client Id**—enter the Client Id obtained in the prerequisites.
    * **OAuth Client Secret**—enter the Client Secret obtained in the prerequisites.
    * **Tenant**—select the tenant type of your hosted application.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Zuora, see [this information page](https://cdn.cdata.com/help/HZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# xBase
Source: https://docs.cloud.cdata.com/en/Data-Sources/xBase



## Setup Guide

Follow these steps to connect xBase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *xBase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Data Source**, which is the path to the folder containing the .dbf files.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and xBase, see [this information page](https://cdn.cdata.com/help/BXM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Integrations
Source: https://docs.cloud.cdata.com/en/Integrations

The ***Integrations*** page presents a list of available integration tools. Use the search field to find an integration tool by name. You can also use the **View** drop-down list to view the integration tools by category: **AI**, **BI and Reporting**, **ETL**, **No-Code/Low-Code**, **Dev**, and **iPaaS**. Each integration tool card contains a link to open its documentation in an embedded navigation pane. Where appropriate, cards also contain links to download connectors and view endpoint information.

<Frame>
  <img alt="Integrations" />
</Frame>

### AI Tools

Below is a list of the Artificial Intelligence (AI) tools that connect to Connect AI:

* [Agent Bricks](/en/Clients/AgentBricks-Client)
* [Amazon Quick](/en/Clients/AmazonQuick-Client)
* [ChatGPT](/en/Clients/ChatGPT-Client)
* [Claude](/en/Clients/Claude-Client)
* [Claude Code](/en/Clients/ClaudeCode-Client)
* [Codex](/en/Clients/Codex-Client)
* [CrewAI](/en/Clients/CrewAI-Client)
* [Cursor](/en/Clients/Cursor-Client)
* [Gemini](/en/Clients/Gemini-Client)
* [Gemini Enterprise](/en/Clients/GeminiEnterprise-Client)
* [GitHub Copilot](/en/Clients/GitHubCopilot-Client)
* [Grok](/en/Clients/Grok-Client)
* [LangChain](/en/Clients/LangChain-Client)
* [LangGraph](/en/Clients/LangGraph-Client)
* [LlamaIndex](/en/Clients/LlamaIndex-Client)
* [Lovable](/en/Clients/Lovable-Client)
* [Microsoft Copilot Studio](/en/Clients/MicrosoftCopilot-Client)
* [Microsoft Foundry](/en/Clients/MicrosoftFoundry-Client)
* [Mistral Le Chat](/en/Clients/Mistral-Client)
* [n8n](/en/Clients/N8N-Client)
* [Replit Agent](/en/Clients/Replit-Client)
* [Windsurf](/en/Clients/Windsurf-Client)

### BI and Reporting Tools

Below is a list of the Business Intelligence (BI) and Reporting tools that connect to Connect AI:

* [Alteryx](/en/Clients/Alteryx-Client)
* [Amazon QuickSight](/en/Clients/AmazonQuickSight-Client)
* [Azure Analysis Services](/en/Clients/AAS-Client)
* [APOS](/en/Clients/APOS-Client)
* [Crystal Reports](/en/Clients/CrystalReports-Client)
* [Excel](/en/Clients/Excel365-Client)
* [Geckoboard](/en/Clients/Geckoboard-Client)
* [Google Sheets](/en/Clients/GoogleSheets-Client)
* [IBM Cognos Analytics](/en/Clients/IBMCognos-Client)
* [Looker](/en/Clients/Looker-Client)
* [Looker Studio](/en/Clients/LookerStudio-Client)
* [Metabase](/en/Clients/Metabase-Client)
* [Microsoft Fabric](/en/Clients/MicrosoftFabric-Client)
* [MicroStrategy](/en/Clients/MicroStrategy-Client)
* [Mode](/en/Clients/Mode-Client)
* [PowerBI.com](/en/Clients/PowerBI.com-Client)
* [Power BI Desktop](/en/Clients/PowerBIDesktop-Client)
* [Qlik Sense](/en/Clients/QlikSenseCloud-Client)
* [Redash](/en/Clients/Redash-Client)
* [SAP Analytics Cloud](/en/Clients/SAPAnalyticsCloud-Client)
* [SAS Viya](/en/Clients/SASViya-Client)
* [Tableau Cloud](/en/Clients/TableauCloud-Client)
* [Tableau Desktop](/en/Clients/TableauDesktop-Client)
* [ThoughtSpot](/en/Clients/ThoughtSpot-Client)
* [Zoho Analytics](/en/Clients/ZohoAnalytics-Client)

### ETL Tools

Below is a list of the Extract, Transform, and Load (ETL) tools that connect to Connect AI:

* [Airbyte](/en/Clients/Airbyte-Client)
* [AWS Glue](/en/Clients/AWSGlue-Client)
* [Azure Data Factory](/en/Clients/AzureDataFactory-Client)
* [CData Sync](/en/Clients/CDataSync-Client)
* [Cloud Data Fusion](/en/Clients/CloudDataFusion-Client)

### No-Code/Low-Code Tools

Below is a list of No-Code/Low-Code tools that connect to Connect AI:

* [AppSheet](/en/Clients/AppSheet-Client)
* [AWS App Studio](/en/Clients/AWSAppStudio-Client)
* [Azure Logic Apps](/en/Clients/AzureLogicApps-Client)
* [Bubble](/en/Clients/Bubble-Client)
* [Filemaker Pro](/en/Clients/Claris-Client)
* [Mendix](/en/Clients/Mendix-Client)
* [Microsoft Power Apps](/en/Clients/MicrosoftPowerApps-Client)
* [Microsoft PowerAutomate](/en/Clients/MicrosoftPowerAutomate-Client)
* [Nintex](/en/Clients/Nintex-Client)
* [Outsystems](/en/Clients/Outsystems-Client)
* [Retool](/en/Clients/Retool-Client)
* [Salesforce External Services](/en/Clients/SalesforceExternal-Client)
* [Salesforce Lightning Connect](/en/Clients/SFLC-Client)
* [Workato](/en/Clients/Workato-Client)
* [Zapier](/en/Clients/Zapier-Client)

### Dev Tools

Below is a list of the development tools that connect to Connect AI:

* [ADO.NET](/en/Clients/ADO.NET-Client)
* [Apps Script](/en/Clients/AppsScript-Client)
* [Axios](/en/Clients/Axios-Client)
* [Choreo](/en/Clients/Choreo-Client)
* [Databricks](/en/Clients/Databricks-Client)
* [Databricks Lakehouse Federation](/en/Clients/DatabricksLHF-Client)
* [Grafana](/en/Clients/Grafana-Client)
* [JDBC](/en/Clients/JDBC-Client)
* [Node.js](/en/Clients/Nodejs-Client)
* [ODBC](/en/Clients/ODBC-Client)
* [Polybase](/en/Clients/Polybase-Client)
* [Python](/en/Clients/Python-Client)
* [SSIS](/en/Clients/SSIS-Client)
* [SQL Server Linked Server](/en/Clients/SQLServerLinked-Client)

### iPaaS Tools

Below is a list of the Integration Platform as a Service (iPaaS) tools that connect to Connect AI:

* [Jitterbit](/en/Clients/Jitterbit-Client)
* [MuleSoft](/en/Clients/Mulesoft-Client)
* [SnapLogic](/en/Clients/SnapLogic-Client)


# Playground
Source: https://docs.cloud.cdata.com/en/Playground

The ***Playground*** page enables you to harness AI to get answers from your connected data. The Playground interface provides connection assistance to many common data sources, such as Jira, GitHub, and Slack. Once you are connected, you can ask natural-language questions about the data in the sources.

## Connect to Your Data

Connect AI's Playground allows you to connect data sources to CData's remote MCP server and obtain insights from your data in real time without a third-party integration tool.

<Frame>
  <img alt="Playground" />
</Frame>

The home page of Playground contains commonly used data sources. Click **Explore Additional Sources** for more options. Click a source, and if the source is not already connected, Connect AI guides you through the appropriate steps to connect the source.

<Note>Click **Connect Integrations** if you want to use a third-party integration tool (such as ChatGPT) to query your data rather than Connect AI Playground.</Note>

For example, click the **Atlassian Jira** tile. If you are not yet connected, the Playground AI asks for your Jira URL to connect to the account. Once you submit a valid URL, the AI creates the Jira connection and asks you to authenticate it using OAuth. Save the connection.

<Frame>
  <img alt="Authenticate Jira" />
</Frame>

After you set up the Jira account, the Playground first checks if you have user-level or connection-level context, or instructions, about how AI should query your data. See [Context Editor](/en/Context-Editor) for more information.

<Note>Adding information in the Context Editor improves the prompt's answers, but it is not required.</Note>

Next, Playground runs a sample prompt to make sure you are connected to the data source, such as "Give me the 5 most recent tickets created in Jira and give me the summary." When the prompt is successful, submit your own prompt. The remote MCP server works to access the relevant catalogs, schemas, and tables. The Playground might prompt you for more information to narrow down the data you need.

You can expand the results of the prompt to obtain details about how the AI tools accessed the data:

<Frame>
  <img alt="Expand prompt results" />
</Frame>

In the example above, the prompt called the tools `getCatalogs`, `getSchemas`, and `executeQuery`.

Click **Reset Chat** to return to the Playground main menu and connect additional data sources.

## Chat Records

Chat records are saved for 30 days so you can return to them later. Click the three dots to the right to rename your prompt or delete it permanently.

## Examples

The following are some of the questions you can ask Playground about your data:

* ***In my Salesforce connection, which deals have we closed in the past month, and what is the total?***

* ***In my LinkedIn Ads connection, summarize the performance for the last 30 days by campaign.***

* ***Which e-commerce products generate the highest gross margin according to NetSuite?***

* ***Identify Salesforce stalled opportunities and explain why they're at risk.***

For a more complete list of prompt ideas, see the CData [prompt library](https://www.cdata.com/ai/prompt-library/). You can filter prompts by data source.

## Ask AI to Search the Documentation

Playground also lets you ask questions about the Connect AI documentation. For example, you can ask Playground: "How do I connect to my Salesforce data?" or "How do I change my email address?" Playground might ask follow-up questions to further assist you.

## Limitations

Playground operates within specific boundaries, as follows:

* **Permissions**: Access to data, including the ability to run queries, is based on catalog permissions granted to the user. Tools such as `getSchemas`, `getTables`, `getColumns`, `getCatalogs`, and `executeQuery` are only accessible with sufficient catalog permissions.

  <Warning>Playground does not perform data deletion queries under any circumstances.</Warning>

* **Query Limits**: Only SELECT, INSERT, UPDATE, and stored procedures are supported. Query responses also cannot exceed 100 rows.

* **Execution**: Actions are limited to the Connect AI ecosystem. Actions or queries outside of the system are ignored.

* **Privacy and Security**: Playground accesses only relevant data and metadata within the Connect AI system. It does not query data or systems outside of authorized Connect AI catalogs.


# Query Builder
Source: https://docs.cloud.cdata.com/en/QueryBuilder

The Connect AI *Query Builder* allows you to build queries from your data without needing to write SQL code.

## Prerequisites

Before you can use the Query Builder, you must properly configure a connection within Connect AI. For more information about configuring a connection, see [Sources](/en/Sources). You can select any of your pre-made connections to query.

## Query Builder

To access the Query Builder, click **Build Query** in the home page of Data Explorer. You can also access the Query Builder by clicking the add tab button and selecting **Query Builder**:

<Frame>
  <img alt="Add query builder tab" />
</Frame>

The **Query Builder** appears in the right pane of the Data Explorer.

<Frame>
  <img alt="Query builder pane" />
</Frame>

To start configuring Query Builder, follow these steps:

<Steps>
  <Step>
    Click **Add Table**. A **Query Builder** dialog appears.

    <Frame>
      <img alt="Query builder dialog" />
    </Frame>
  </Step>

  <Step>
    Select a Connect AI connection from the **Connection** list.
  </Step>

  <Step>
    Select a schema for the connection from the **Schema** field.
  </Step>

  <Step>
    Select the table you are interested in querying from the **Table** field. <Note>You can add additional tables in the **Add Data** step.</Note>
  </Step>

  <Step>
    Click **Confirm**. Your initial query appears in the Query Builder.

    <Frame>
      <img alt="Query builder initial" />
    </Frame>
  </Step>
</Steps>

You are now ready to add other elements to your query, such as additional tables, dimensions, metrics, filters, and sorts. At any time, you can click the **SQL** tab to see your Query Builder query as SQL code. Click the **Preview** tab to preview the query results.

### Combine Data from Additional Tables

The Query Builder can create queries from multiple tables. To add a table to your query, follow these steps:

<Steps>
  <Step>
    In the **Builder** tab of the Query Builder, click **Add Data**. An **Add Data** dialog appears.

    <Frame>
      <img alt="Query builder add data" />
    </Frame>
  </Step>

  <Step>
    Select a **Join Type**. The join types available in Query Builder are as follows:

    * **Inner Join**—this is the most common type of join. Connect AI combines records from the original and added table whenever there are matching values in a column common to both tables. It is equivalent to `INNER JOIN` in SQL.
    * **Right Join**—this type of join returns all records from the added (new) table, plus the matching records from the original table. It is equivalent to `RIGHT JOIN` in SQL.
    * **Left Join**—this type of join returns all records from the original table, plus the matching records from the added table. It is equivalent to `LEFT JOIN` in SQL.
    * **Full Outer Join**—this type of join returns all records where there is a match in either the original table or in the added table. If there is no match, the result contains `NULL` values for columns from the table that does not have a matching row. It is equivalent to `FULL JOIN` in SQL. This join results in the largest data set.
  </Step>

  <Step>
    Select a **Connection** containing the new table you want to add.
  </Step>

  <Step>
    Select the **Schema** containing the new table.
  </Step>

  <Step>
    Select the **Table Name** to add.
  </Step>

  <Step>
    Select the **Column Name** in the original table and the new table. This is the column on which to join the two tables. Note that the joining columns must be of the same data type.
  </Step>

  <Step>
    Click **Confirm** to save your new table. Your new table appears in the Query Builder in the **Data** section.

    <Frame>
      <img alt="Query builder data section" />
    </Frame>
  </Step>

  <Step>
    Click the **SQL** tab to view your query in SQL code:

    <Frame>
      <img alt="Query builder SQL view" />
    </Frame>
  </Step>

  <Step>
    Click **Add Data** again to join additional tables. You can add a maximum of three joined tables. Click the edit icon to edit the joined table and the delete icon to delete the joined table.
  </Step>
</Steps>

### Add Dimensions to Results

A dimension is a categorical variable used to describe and segment data. It represents qualitative attributes and is often used to group or filter data. Dimensions help in breaking down data into more meaningful segments and provide context. For example, if you have sales data, the dimensions might include the sales region or the time period.

To add dimensions to your Query Builder results, follow these steps:

<Steps>
  <Step>
    In the **Dimensions** section of the Query Builder, click **Add Dimensions**. An **Add Dimensions** dialog appears.
  </Step>

  <Step>
    For each table in the query, select column names from the drop-down list. These are the columns you want to see in the result set.
  </Step>

  <Step>
    Click **Confirm**. All the columns you selected appear in the **Dimensions** section of the Query Builder. Hover over the dimension to view the full table name.

    <Frame>
      <img alt="Query builder dimensions" />
    </Frame>
  </Step>

  <Step>
    You can drag and drop the columns to change the order. Click **Add Dimensions** to add more dimensions. Click the X on the dimension to delete the dimension.
  </Step>
</Steps>

### Add Metrics to Aggregate Data

A metric is a quantitative measure used to assess performance or progress. It represents numerical values that can be aggregated, compared, or analyzed. Metrics provide the actual data points that are measured and analyzed. They are used to evaluate the performance and outcomes based on the dimensions. For example, you can display the total dollar amount of sales with SUM or count the number of unique clients with DISTINCT COUNT.

To add metrics to your Query Builder results, follow these steps:

<Steps>
  <Step>
    In the **Metrics** section of the Query Builder, click **Add Metrics**. An **Add Metrics** dialog appears.
  </Step>

  <Step>
    Select the table name, column name, and the metric type to use to aggregate the results. Note that the metric types displayed depend on the column type. For example, string columns can use only COUNT or DISTINCT COUNT.
  </Step>

  <Step>
    Click **Confirm**. The column and the metric to use appear in the **Metrics** sections of the Query Builder. Hover over the metric to view the full table name.

    <Frame>
      <img alt="Query builder metrics" />
    </Frame>
  </Step>

  <Step>
    You can drag and drop the columns to change the order. Click **Add Metrics** to add more metrics. Click the X on the metric to delete the metric.
  </Step>
</Steps>

### Add Filters to the Data

Filters refine your data so that only relevant information is included in your query results.

The SQL operator to apply to your query depends on the data type of the column. If the column is a text data type, you can choose the following operators only:

* Equal to
* Not equal to

If the column is numeric or alphanumeric, you can choose the following operators only:

* Between
* Equal to
* Greater than
* Greater than or equal to
* Less than
* Less than or equal to
* Not equal to

To add filters to your Query Builder results, follow these steps:

<Steps>
  <Step>
    In the **Filters** section of the Query Builder, click **Add Filters**. An **Add Filters** dialog appears.
  </Step>

  <Step>
    Select the table name, column name, the SQL operator to apply, and the value for the filter.
  </Step>

  <Step>
    Click **Confirm**. The column, operator type, and value appear in the **Filters** section of the Query Builder.

    <Frame>
      <img alt="Query builder filters" />
    </Frame>
  </Step>

  <Step>
    Click **Add Filters** to add more columns to filter, if desired. Select whether all filter conditions must be true (**And**) or at least one of the filters is true (**Or**).
  </Step>

  <Step>
    Use the edit icon to edit the filter definition, and the delete icon to delete the filter.
  </Step>
</Steps>

### Sort the Data

To sort the resulting data, follow these steps:

<Steps>
  <Step>
    In the **Sort** section of the Query Builder, click **Add Sorts**. An **Add Sorts** dialog appears.
  </Step>

  <Step>
    Select the table name and column name to sort.
  </Step>

  <Step>
    Select whether the sort is ascending or descending.
  </Step>

  <Step>
    Click **Confirm**. The table name, column name, and the sort type appear in the **Sort** section of the Query Builder.
  </Step>

  <Step>
    Click **Add Sorts** to add more columns to sort, if desired. Use the grid icon to the left to change the order of the sort columns. Click the edit icon to edit the sort definition, and the delete icon to delete the sort.

    <Frame>
      <img alt="Query builder sort" />
    </Frame>
  </Step>
</Steps>

### Execute and Save the Query

To execute and save the query, follow these steps:

<Steps>
  <Step>
    When you are satisfied with the preview of your query, click **Execute** to execute the query. The query results appear in a new tab.

    <Frame>
      <img alt="Query builder execute" />
    </Frame>
  </Step>

  <Step>
    Click **Save** to save the query as a derived view, a saved query, or a scheduled query. If you save as a derived view or saved query, a **Save** dialog appears.
    <Note>If you save the query as a scheduled query, an **Add Job** page appears. This is where you add details about the scheduled query job, such as how often it runs. See [Scheduled Queries](/en/Scheduled-Queries) for details.
    For more information about derived views, see [Configuring Derived Views](/en/Data-Explorer#configure-derived-views). For more information about saved queries, see [Saving a Query](/en/Data-Explorer#save-a-query).</Note>
  </Step>

  <Step>
    Enter the saved query or derived view name, and click **Confirm**. The saved query or derived view appears in the Data Explorer.
  </Step>

  <Step>
    Click **Download CSV** to save your query results as a CSV file.
  </Step>

  <Step>
    You can also save your SQL query by clicking **Copy** in the SQL tab of the Query Builder and pasting it into any text editor.
  </Step>
</Steps>


# Active Directory Federation Services (ADFS) SSO Troubleshooting
Source: https://docs.cloud.cdata.com/en/ADFSTroubleshooting

Common questions and issues when configuring Active Directory Federation Services (ADFS) as your SSO provider for Connect AI, with suggested solutions.

<Note>
  Connect AI uses Auth0 as its managed identity broker. You run ADFS, so the claim rules, certificates, and relying party trust are configured on your side. Steps that refer to the Auth0 tenant, the connection's federation metadata, or Rules and Actions are configured by CData on the broker side. If one applies to your issue, contact [CData Support](https://www.cdata.com/support/submit.aspx).
</Note>

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="Which SAML NameID format should we use?">
    EmailAddress is recommended and the most widely used. Persistent and Unspecified are also accepted by the broker, but Email keeps mapping straightforward.
  </Accordion>

  <Accordion title="Can I limit which users can log in?">
    Yes. On your side, grant access only to the intended users or groups in the relying party trust within ADFS. A second layer, filtering with Auth0 Rules or Actions, is configured by CData on the broker side; contact [CData Support](https://www.cdata.com/support/submit.aspx) if you need it.
  </Accordion>

  <Accordion title="Should we provide a metadata file or a metadata URL?">
    A federation metadata endpoint is preferred over a standalone file. When the endpoint (`/FederationMetadata/2007-06/FederationMetadata.xml`) is reachable, the broker can pick up configuration changes automatically, such as a new token-signing certificate added ahead of a rollover. CData enters this on the broker side, so make sure the endpoint is enabled and reachable in ADFS, then share its location when SSO is provisioned.
  </Accordion>
</AccordionGroup>

## Common Errors

<AccordionGroup>
  <Accordion title="The test connection fails with an invalid signature.">
    The certificate registered with the broker has to match your ADFS token-signing certificate. Confirm it is the current signing certificate and that the value carries no stray characters and includes the surrounding `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` lines. Because the certificate is held on the broker side, contact [CData Support](https://www.cdata.com/support/submit.aspx) if it needs to be updated, for example after a certificate rollover.
  </Accordion>

  <Accordion title="The ADFS sign-in page appears but the redirect fails.">
    The ACS URL set in ADFS has to match the callback URL exactly. It follows this pattern, where the tenant and connection name are the values CData provides when SSO is enabled for your account:
    `https://<AUTH0-TENANT>.auth0.com/login/callback?connection=<CONNECTION_NAME>`

    If you do not have the exact values, contact [CData Support](https://www.cdata.com/support/submit.aspx).
  </Accordion>

  <Accordion title="No NameID or email is found in the assertion.">
    * Review your ADFS claim rules and make sure the Name ID is mapped to the user's email address.
    * Inspect the assertion with a browser tool such as SAML-tracer to confirm what ADFS is actually sending.
  </Accordion>
</AccordionGroup>

To enable SSO for your account or for additional help, contact [CData Support](https://www.cdata.com/support/submit.aspx).


# Active Directory/LDAP SSO Troubleshooting
Source: https://docs.cloud.cdata.com/en/ActiveDirectoryLDAPTroubleshooting

Common questions and issues when configuring Active Directory/LDAP as your SSO provider for Connect AI, with suggested solutions.

<Note>
  Connect AI uses Auth0 as its managed identity broker. Active Directory/LDAP connections rely on the Auth0 AD/LDAP Connector, an on-premises agent that bridges your directory to the broker. CData installs and operates this connector on the broker side. Most of the diagnostics below are therefore handled by CData rather than configured by you. The one task on your side is making sure CData can reach your directory.
</Note>

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="What do I need to provide to enable Active Directory/LDAP SSO?">
    CData runs the AD/LDAP connector on the broker side, so you do not install or configure any software yourself. When SSO is provisioned, you do need to supply CData with the details needed to reach your directory: the host and port, a service (bind) account, and any firewall or VPN allowances. Contact [CData Support](https://www.cdata.com/support/submit.aspx) to coordinate this.
  </Accordion>

  <Accordion title="Can I limit which users are allowed to sign in?">
    Yes. Restrict access within your directory by scoping the relevant users, groups, or organizational units. Any additional filtering at the broker is configured by CData; contact [CData Support](https://www.cdata.com/support/submit.aspx) if you need it.
  </Accordion>
</AccordionGroup>

## Common Errors

<AccordionGroup>
  <Accordion title="Sign-in fails and the directory cannot be reached.">
    Connectivity is the one area you can check directly. Confirm that the connector host CData operates is allowed to reach your LDAP server: verify firewall rules, VPN routes, and that the LDAP port is open. If your network is correctly open and sign-in still fails, contact [CData Support](https://www.cdata.com/support/submit.aspx) so they can run the connector diagnostics.
  </Accordion>

  <Accordion title="Authentication fails even though the directory is reachable.">
    The remaining causes are on the broker side that CData manages, including:

    * Clock drift between the connector host and the broker.
    * A missing certificate in the connector's trust store.
    * Insufficient privileges on the service (bind) account.
    * Proxy settings on the connector host.

    Contact [CData Support](https://www.cdata.com/support/submit.aspx) to investigate these.
  </Accordion>
</AccordionGroup>

To enable SSO for your account or for additional help, contact [CData Support](https://www.cdata.com/support/submit.aspx).


# Azure Analysis Services
Source: https://docs.cloud.cdata.com/en/Clients/AAS-Client

This page outlines the steps to connect Azure Analysis Services to Connect AI. You can use either Connect AI Virtual SQL Server API or the Connect AI OData endpoint to connect. Note that the performance of Azure Analysis Services is much slower with an OData connection.

## Prerequisites for Connecting via Virtual SQL Server API

Before you connect via Virtual SQL Server API, you must first do the following:

* Create a server in Azure Analysis Services to which you will deploy your data from Connect AI.
* An on-premises data gateway is required when one or more Azure Analysis Services servers in the same region connect to on-premises data sources. To install and configure an on-premises gateway to access data sources, refer to the Microsoft documentation: [Install an On-Premises Gateway](https://learn.microsoft.com/en-us/azure/analysis-services/analysis-services-gateway-install?tabs=azure-portal).
* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via Virtual SQL Server API

To establish a connection from Azure Analysis Services to the Connect AI Virtual SQL Server API, follow these steps.

<Note>
  These steps involve creating a tabular model project through Visual Studio and deploying the model to Azure Analysis Services. For further instructions on using Azure Analysis Services, please refer to Microsoft documentation.
</Note>

### Step 1: Prepare Visual Studio

<Steps>
  <Step>
    Open Visual Studio. In the navigation bar, select **Extensions** > **Manage Extensions**.
  </Step>

  <Step>
    In the search bar, enter *Microsoft Analysis Services Projects 2022*. When it appears in the list, click **Download**.
  </Step>

  <Step>
    When the installer file finishes downloading, close Visual Studio and double-click the extension installation file to install it.
  </Step>

  <Step>
    Follow the installation prompts. When the installation finishes, restart Visual Studio.
  </Step>
</Steps>

### Step 2: Create the Data Model Project

<Steps>
  <Step>
    In Visual Studio, create a new project.
  </Step>

  <Step>
    Select **Analysis Services Tabular Project**.
  </Step>

  <Step>
    In **Configure your new project**, enter a name for your project in the **Project name** field.
  </Step>

  <Step>
    Specify a location for the project files and set **Framework** to the latest available value.

    <Frame>
      <img alt="Azure Analysis Configure New Project" />
    </Frame>
  </Step>

  <Step>
    Click **Create**. The **Tabular model designer** dialog opens.
  </Step>

  <Step>
    Select **Workspace server** and enter the address of your Azure Analysis Services server (for example, `asazure://eastus.azure.windows.net/myAzureServer`).
  </Step>

  <Step>
    Set **Compatibility Level** to **SQL Server 2022 / Azure Analysis Services (1600)**.

    <Note>
      The rest of this guide is written for this compatibility level. If you select a different compatibility level, the steps below may not apply, and you might encounter issues when connecting to your data.
    </Note>

    <Frame>
      <img alt="Azure Analysis TMD" />
    </Frame>
  </Step>

  <Step>
    Click **Test Connection** and sign in to your server.
  </Step>

  <Step>
    Click **OK** to create the project. Your Visual Studio window should resemble the following screenshot:

    <Frame>
      <img alt="Azure Analysis Start" />
    </Frame>
  </Step>
</Steps>

### Step 3: Import Data

<Steps>
  <Step>
    In Visual Studio, in **Tabular model Explorer**, right-click **Data Sources** and select **Import From Data Source**.

    <Frame>
      <img alt="Azure Analysis Import" />
    </Frame>
  </Step>

  <Step>
    In **Table Import Wizard**, select **SQL Server database** and click **Connect**.

    <Frame>
      <img alt="Azure Analysis SSDB" />
    </Frame>
  </Step>

  <Step>
    In the **Server** field, enter the Virtual SQL Server endpoint and port separated by a comma: *tds.cdata.com*,*14333*.

    <Frame>
      <img alt="Azure Analysis Enter DB" />
    </Frame>
  </Step>

  <Step>
    Click **OK**. In the new window, select **Database**.
  </Step>

  <Step>
    Enter the following information:

    * **User name**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="Azure Analysis Enter Credentials" />
    </Frame>
  </Step>

  <Step>
    Click **Connect**. In the **Navigator** window that opens, select your desired data source and click **OK**.

    <Frame>
      <img alt="Azure Analysis Navigator" />
    </Frame>
  </Step>

  <Step>
    **Navigator** refreshes and displays the tables in your data source. Select your tables and click **Load**.

    <Frame>
      <img alt="Azure Analysis Table Select" />
    </Frame>
  </Step>
</Steps>

### Step 4: Deploy the Project

<Steps>
  <Step>
    In Visual Studio, select **Solution Explorer**.

    <Frame>
      <img alt="Azure Analysis Solution" />
    </Frame>
  </Step>

  <Step>
    Right-click your project and select **Deploy**.

    * For more information about deploying data, please see [this Microsoft help page](https://learn.microsoft.com/en-us/azure/analysis-services/analysis-services-deploy).
    * For more information about on-premises data gateways, please see [this Microsoft help page](https://learn.microsoft.com/en-us/azure/analysis-services/analysis-services-gateway-install?tabs=azure-portal).
  </Step>
</Steps>

Once you deploy your data to Azure Analysis Services, you can use your data to create data models. For more information please see [Azure Analysis Services documentation](https://learn.microsoft.com/en-us/azure/analysis-services/).

## Prerequisites for Connecting via OData Endpoint

If you do not want to use a local gateway with Azure Analysis Services, you can use an OData endpoint to connect to Connect AI. However, the performance is slower than with a Virtual SQL Server connection.

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Create a [Workspace](/en/Workspaces). Later, you will use the **OData Service URL** on that page (*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*) with the relevant workspace name to establish the connection.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via OData Endpoint

To connect to Connect AI using the OData protocol, follow these steps.

<Steps>
  <Step>
    After creating a project in Azure Analysis Services, right-click the data source option and select **New Data Source**.

    <Frame>
      <img alt="Azure Analysis New Data Source" />
    </Frame>
  </Step>

  <Step>
    Search for *OData Feed*.

    <Frame>
      <img alt="Azure Analysis OData Feed" />
    </Frame>
  </Step>

  <Step>
    In the **OData feed** dialog, enter the following URL: *[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*. Then click **OK**.

    <Frame>
      <img alt="Azure Analysis OData URL" />
    </Frame>
  </Step>

  <Step>
    Next, enter **Basic** credentials. The **User name** is your Connect AI user name, and the **Password** is the PAT from the prerequisites.

    <Frame>
      <img alt="Azure Analysis OData Credentials" />
    </Frame>
  </Step>

  <Step>
    Click **Connect** to test the new connection.
  </Step>

  <Step>
    In the **Navigator**, select the desired table and click **Load**.

    <Frame>
      <img alt="Azure Analysis OData Load" />
    </Frame>
  </Step>

  <Step>
    You can now view your data in the Navigator.

    <Frame>
      <img alt="Azure Analysis OData Navigator" />
    </Frame>
  </Step>
</Steps>


# ADO.NET
Source: https://docs.cloud.cdata.com/en/Clients/ADO.NET-Client

This page outlines the steps that are required to use the Microsoft ADO.NET data provider for Connect AI.

## Prerequisites

Before you can configure and use ADO.NET with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Install the Provider

Follow these steps to download and install the provider:

<Steps>
  <Step>
    [Download](https://www.cdata.com/download/getfile.aspx?file=free/LFRK-A/setup.exe\&name=ADO.NET%20Provider%20for%20CData%20Connect\&tag=Download-ado) and run the ADO.NET setup file.
  </Step>

  <Step>
    The installer can automatically detect software that supports ADO.NET, such as Visual Studio. Select the options that you want the installer to configure.
  </Step>

  <Step>
    After installation, the ADO.NET Provider will be available in the software that you selected during installation.
  </Step>
</Steps>

## Connect to Connect AI

Connect AI uses OAuth to establish a connection between the ADO.NET Provider and your account. The steps below provide an example of configuring the ADO.NET Provider in Visual Studio 2022:

<Steps>
  <Step>
    In Visual Studio, click **Tools** > **Connect to Database**.
  </Step>

  <Step>
    Select **CData Connect Data Source** as your Data Source.
  </Step>

  <Step>
    In the **Data Provider** drop-down menu, select **ADO.NET Provider for CData Connect 2021** and click **Continue**.
  </Step>

  <Step>
    The **Add Connection** window appears. In the **Auth Scheme** field, select **OAuth**. Do not fill out other fields.
  </Step>

  <Step>
    Click **Test Connection**.

    * If you are already logged in, a success message appears.
    * If you are not logged in, the Connect AI sign-in window opens in your web browser. Sign in and return to Visual Studio.
  </Step>

  <Step>
    Click **OK** on the success message and **OK** in the **Add Connection** window.
  </Step>
</Steps>

Your connection appears in the **Server Explorer** pane under the **Data Connections** section.

## Connect to a Workspace

To connect the ADO client to a specific [workspace](/en/Workspaces), you specify the workspace name in the **Workspace** field of the **Add Connection** window.

<Frame>
  <img alt="ADO.NET Specify Workspace" />
</Frame>

## Learn More

To learn more information about using the ADO.NET Provider for Connect AI, click [here](https://cdn.cdata.com/help/LFM/ado/default.htm).


# APOS
Source: https://docs.cloud.cdata.com/en/Clients/APOS-Client



## Prerequisites

You must connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Connect to Connect AI

To establish a connection from APOS to the Connect AI Virtual SQL Server API, please follow these steps.

<Steps>
  <Step>
    Log in to APOS Live Data Gateway Manager.
  </Step>

  <Step>
    In the APOS Live Data Gateway Manager, click **Add**.

    <Frame>
      <img alt="APOS Client" />
    </Frame>
  </Step>

  <Step>
    Enter the connection information in the **Connection** tab of the dialog that appears.

    * **Data source**—select **Database**
    * **Database**—select **JDBC Generic**
    * **Connection String**—supply the connection string information in this format, where databaseName is the name of a configured connection in Connect AI: `jdbc:sqlserver://tds.cdata.com:14333;databaseName=MyConnectionName;`
    * **Driver Class**—set to `com.CData.connect.Driver` (this should be set by default)
  </Step>

  <Step>
    Click **Test Connection**.
  </Step>

  <Step>
    Click **Save** and give your connection a unique prefix.
  </Step>
</Steps>

Once your connection is created, it appears in the **Available Connection** table. Now you can use it to create semantic layer views in the APOS Live Data Gateway Web UI.


# AWS App Studio
Source: https://docs.cloud.cdata.com/en/Clients/AWSAppStudio-Client

AWS App Studio is an AWS service that enables application development using generative AI. When connected to Connect AI, AWS App Studio lets you develop applications using SaaS data.

This page outlines the steps to connect AWS App Studio to your Connect AI account.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* [Add a workspace](/en/Workspaces#add-a-workspace) to Workspaces.
* [Add assets](/en/Workspaces#workspace-assets) to your workspace.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via OpenAPI

To establish a connection from AWS App Studio to Connect AI via OpenAPI, follow these steps.

<Steps>
  <Step>
    In **Workspaces** in Connect AI, select a workspace and download the OpenAPI specification for the workspace. See [OpenAPI](/en/API/OpenAPI) for more information.

    <Note>
      You must use OpenAPI version 3.0.
    </Note>

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Log in to AWS App Studio.
  </Step>

  <Step>
    Open the Admin hub.
  </Step>

  <Step>
    Click **Create Connector**.
  </Step>

  <Step>
    In the **Select a connector** page, select **OpenAPI Connector**.
  </Step>

  <Step>
    In the **OpenAPI Connector Configuration** page, configure the following:

    * **Name**—enter a name of your choice for the connection.
    * **Description**—if desired, enter a description for the connection.
    * **Base URL**—the URL of the OpenAPI Specification file.
    * **Authentication method**—select **Basic**.
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **OpenAPI Specification file**—import the OpenAPI Specification file you downloaded from Connect AI.
  </Step>

  <Step>
    Save the connector.
  </Step>
</Steps>

## Use the OpenAPI Connection in AWS App Studio

<Steps>
  <Step>
    Open the Builder hub.
  </Step>

  <Step>
    Click **Create app** and give the application a name.
  </Step>

  <Step>
    Click **Add automation**.
  </Step>

  <Step>
    In the **Actions** tab to the right of the application creation screen, click **Invoke API** and add it to a flow.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the **Properties** tab to the right of the application creation screen, select the OpenAPI connector you created.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Confirm the contents of the OpenAPI connector.
  </Step>

  <Step>
    Once the flow is successfully completed, you can test the outputs for your flow.
  </Step>
</Steps>


# AWS Glue
Source: https://docs.cloud.cdata.com/en/Clients/AWSGlue-Client

This page outlines the steps to connect AWS Glue to your Connect AI account.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

Follow these steps to establish a connection from AWS Glue to Connect AI:

<Steps>
  <Step>
    Log in to AWS Glue.
  </Step>

  <Step>
    In the navigation pane, under **ETL**, select **AWS Glue Studio**.
  </Step>

  <Step>
    On the AWS Glue Studio page, click **View Connectors**.
  </Step>

  <Step>
    In the **Marketplace Connectors** box, click **Go to AWS Marketplace**.
  </Step>

  <Step>
    Enter *Connect AI* in the Marketplace search bar.
  </Step>

  <Step>
    Select **CData AWS Glue Connector for CData Connect**. The connector page opens in a new browser tab.
  </Step>

  <Step>
    At the top of the connector page, click **Continue to Subscribe**.
  </Step>

  <Step>
    On the next page, click **Continue to Configuration**, and then click **Continue to Launch** on the following page.
  </Step>

  <Step>
    On the **Launch this software** page, click **Usage Instructions**. In the dialog that appears, click **Activate the connector with AWS Glue Studio**.
  </Step>

  <Step>
    GlueStudio opens in a new browser tab. Set the connection properties as follows:

    * **Name**—enter a name of your choice for the connection.
    * **Description**—if desired, enter a description for the connection.
    * **Connection credential type**—select **connect\_cloud**.
    * **AWS Secret**—leave this blank.
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **defaultCatalog**—the name of the connection that you want to access. For example, *Salesforce1*.
  </Step>

  <Step>
    At the bottom of the page, click **Create connection and activate connector**.
  </Step>
</Steps>

Your connection now appears in the **Connections** list in Glue Studio.

## Create an IAM Role

To access your data in AWS Glue, you must have an IAM Role with the correct permissions. If you have not created an IAM Role in AWS Glue, follow the [AWS instructions for creating an IAM Role](https://docs.aws.amazon.com/glue/latest/dg/create-an-iam-role.html).

When selecting the permissions policies, ensure that you select the following AWS Managed policies at a minimum:

* **AmazonS3FullAccess**
* **AmazonEC2ContainerRegistryReadOnly**
* **AWSGlueServiceRole**

If you are using AWS Secrets Manager to store confidential connection properties, create and add an inline policy similar to the following, granting access to the specific secrets needed for the AWS Glue job:

```json theme={null}
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "secretsmanager:GetResourcePolicy",
                "secretsmanager:GetSecretValue",
                "secretsmanager:DescribeSecret",
                "secretsmanager:ListSecretVersionIds"
            ],
            "Resource": [
                "arn:aws:secretsmanager:us-east-2:111222333:secret:CDataSecret-abcdef"
            ]
        }
    ]
}
```

You will use this role when creating a job in AWS Glue.

## Use the Connection in AWS Glue

After you create your connection to Connect AI, you can use the connection to create a job. Follow these steps:

<Steps>
  <Step>
    Select the connection in the **Connections** list.
  </Step>

  <Step>
    Click **Create Job**.
  </Step>

  <Step>
    Select **CData AWS Glue Connector for CData Connect** in the visual flow.
  </Step>

  <Step>
    On the **Data source properties - Connector** tab:

    * Select the connection you created above.
    * Select either **Enter table name** or **Write a query**.
      * If you select Enter table name, in the **Table name** field, enter the fully-qualified name of the table you want to access in the format *ConnectionName.ConnectionType.TableName*. For example, *Salesforce1.Salesforce.Customers*.
      * If you select Write a query, use the fully-qualified name of the table that you want to access when writing the query.
    * Open **Job bookmark options**. In the field labeled **Enter key**, enter the name of the primary key of the table you are accessing. Alternatively, you can open the **Job details** tab and set **Job bookmark** to *Disable*.
  </Step>

  <Step>
    In the visual flow, select the **Job details** tab.
  </Step>

  <Step>
    Enter a name for the job.
  </Step>

  <Step>
    In the **IAM Role** field, enter the name of the [IAM Role you created above](#create-an-iam-role).
  </Step>

  <Step>
    Save the job.
  </Step>
</Steps>

You can now run the job as part of your AWS Glue flow.


# Airbyte
Source: https://docs.cloud.cdata.com/en/Clients/Airbyte-Client

This page outlines the steps to connect Airbyte to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Airbyte to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to your Airbyte account.

    <Frame>
      <img alt="Airbyte login" />
    </Frame>
  </Step>

  <Step>
    On the left pane, click **Sources**, then **Add New Source**.
  </Step>

  <Step>
    Select MSSQL Server from **Source Type** to connect the TDS endpoint.
  </Step>

  <Step>
    Enter your **Source Name**.
  </Step>

  <Step>
    Enter your **Host** URL. In this case the host is *tds.cdata.com*.
  </Step>

  <Step>
    Add the **Port** to connect to. In the example, the port is *14333*.
  </Step>

  <Step>
    Enter the **Database** to connect to. In the example, the Database is *GoogleSheets1*.
  </Step>

  <Step>
    Enter the **Username** you use to connect to the source.
  </Step>

  <Step>
    For the **SSL Method**, use **Encrypted (trust server certificate)**, leave the **Replication Method** as standard, and the **SSH Tunnel Method** as **No Tunnel**.
  </Step>

  <Step>
    Add any **Schema** you want to apply to the source.
  </Step>

  <Step>
    Enter your **Password** for the source.

    <Frame>
      <img alt="Airbyte source" />
    </Frame>
  </Step>

  <Step>
    (Optional) Enter any needed **JDBC URL Params**.

    <Note>
      When connecting with Airbyte On-Premises, enter `workstationID=Airbyte` in this field.
      Do not include `;` at the end of the property.
    </Note>

    <Frame>
      <img alt="Airbyte on-prem" />
    </Frame>
  </Step>

  <Step>
    Click **Test and Save** to create the data source. You can now connect your source with a destination, which you will need to create separately.
  </Step>

  <Step>
    To connect your new source with your destination, click **Connections** and then **Set Up Connection**.
  </Step>

  <Step>
    Select the source created above and your desired destination, then allow Airbyte to process. When it is done, your connection is ready for use.
  </Step>
</Steps>


# Alteryx
Source: https://docs.cloud.cdata.com/en/Clients/Alteryx-Client

This page outlines the steps that are required to use Alteryx with Connect AI. These instructions include Alteryx Desktop and Alteryx Cloud editions.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.
* If you are connecting to Connect AI using Alteryx Desktop, you must have the Microsoft ODBC Driver for SQL Server installed. Click [here](https://go.microsoft.com/fwlink/?linkid=2280794) for the download.

## Connect to Connect AI from Alteryx Desktop

To establish a connection from Alteryx Desktop to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Set up an account in Alteryx.
  </Step>

  <Step>
    Drag and drop a new Input Data tool onto the workflow.

    <Frame>
      <img alt="Alteryx Drag Input" />
    </Frame>
  </Step>

  <Step>
    While the Input Data tool is selected, click **Set Up a Connection** in the navigation pane. A **Data connections** dialog appears.
  </Step>

  <Step>
    Click **Data sources**. Select **Microsoft SQL Server > \*\*Quick connect**.

    <Frame>
      <img alt="Alteryx SQL Server Connect" />
    </Frame>
  </Step>

  <Step>
    In the **Connection Manager** dialog, click **New**.
  </Step>

  <Step>
    In the **New Data Source** dialog, enter the following information:

    * **Data Source Name**—*Microsoft SQL Server ODBC DSN-less*.
    * **Driver**—select **ODBC Driver 18 for SQL Server** from the drop-down list.
    * **Server**—*tds.cdata.com*,*14333*
    * **Database**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).

    <Frame>
      <img alt="Alteryx New Data" />
    </Frame>
  </Step>

  <Step>
    Click **Save**. Then click **Connect Credential**.
  </Step>

  <Step>
    In **Connections**, enter the following:

    * **Authentication Method**—select **Username and password**.
    * **Credential**—select **Create New Credential**.
    * **Credential Name**—enter a name to identify the credential.
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
  </Step>

  <Step>
    Click **Test Connection**. If successful, click **Create and link**.
  </Step>

  <Step>
    **Connect** with your credentials.
  </Step>

  <Step>
    In the wizard that opens, drag and drop the table to be queried in the **Query Builder box**. Select the fields by checking the boxes that you want to include in your query. Where possible, the complex queries generated by the filters and aggregations will be pushed down to your data source, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL engine embedded in the connector.

    <Frame>
      <img alt="Alteryx Query Builder" />
    </Frame>
  </Step>

  <Step>
    To further customize the dataset, you can open the SQL Editor and modify the query manually, adding clauses, aggregations, and other operations to ensure that you are retrieving exactly the data desired.

    <Frame>
      <img alt="Alteryx SQL Editor" />
    </Frame>
  </Step>

  <Step>
    With the query defined, you are ready to work with your data in Alteryx Designer.

    <Frame>
      <img alt="Alteryx Designer" />
    </Frame>
  </Step>
</Steps>

## Connect to Connect AI from Alteryx Cloud

To establish a connection from Alteryx Cloud to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Sign in to your Alteryx Cloud account.
  </Step>

  <Step>
    Click **Create Connection**.
  </Step>

  <Step>
    Search for *Microsoft SQL Server* and the click the data source. A **Create Connection** dialog appears.

    <Frame>
      <img alt="Alteryx Create Connection" />
    </Frame>
  </Step>

  <Step>
    Enter the following information:

    * **Connection Name**—the name of your data connection for display purposes.
    * **Host**—*tds.cdata.com*
    * **Port**—*14333*
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
  </Step>

  <Step>
    Click **Test Connection** to test.
  </Step>

  <Step>
    Click **Create** to save your successful connection.
  </Step>

  <Step>
    In the **Connections** screen, click **Browse Data**. You can now work with the connected data.

    <Frame>
      <img alt="Alteryx Connection List" />
    </Frame>
  </Step>
</Steps>


# Amazon QuickSight
Source: https://docs.cloud.cdata.com/en/Clients/AmazonQuickSight-Client

This page outlines the steps to connect Amazon QuickSight to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Amazon QuickSight to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Amazon QuickSight.
  </Step>

  <Step>
    In the navigation pane, select **Datasets**.

    <Frame>
      <img alt="QuickSight Datasets" />
    </Frame>
  </Step>

  <Step>
    On the Datasets page, click **New Dataset**.
  </Step>

  <Step>
    Select **SQL Server**.
  </Step>

  <Step>
    Enter the connection information in the dialog that appears.

    * **Data source name**—a name that you will use to identify the data source.
    * **Connection type**—select **Public network**.
    * **Database server**—enter *tds.cdata.com*
    * **Port**—enter *14333*
    * **Database name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **Enable SSL**—enabled

    <Frame>
      <img alt="QuickSight New Source" />
    </Frame>
  </Step>

  <Step>
    Click **Validate connection** to test your entered credentials. If you receive an error, check all fields and try again.
  </Step>

  <Step>
    Click **Create data source**.
  </Step>
</Steps>

Once your connection is created, it appears under the **From Existing Data Sources** section of your Dataset list. The **Choose your table** dialog automatically appears for you to select a schema and tables to issue a query. You can manually open this dialog again by clicking your data source in the list. When selecting Schema, make sure to avoid any dbo schemas and select the actual schema instead.


# AppSheet
Source: https://docs.cloud.cdata.com/en/Clients/AppSheet-Client

This page outlines the steps to connect AppSheet to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from AppSheet to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to AppSheet.
  </Step>

  <Step>
    In the top navigation bar, select **My account**.
  </Step>

  <Step>
    On the **Sources** tab, select **New Data Source**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the data source list, select **Cloud Database**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter the connection settings.

    * **Type**—select **SQLServer**.
    * **Server**—enter the Virtual SQL Server endpoint and port separated by a comma: *tds.cdata.com*,*14333*
    * **Database**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **SSL**—set to **Require SSL**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Test** to test your entered credentials. If you receive an error, check all fields and try again.
  </Step>

  <Step>
    Click **Authorize Access** to create the connection.
  </Step>
</Steps>

After you create your data source, it appears on the Account Sources list. When creating an app in AppSheet, you can select tables from your connection as the source of data.


# Apps Script
Source: https://docs.cloud.cdata.com/en/Clients/AppsScript-Client

This page outlines the steps to connect Apps Script to Connect AI via the Query API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

In order to connect from Apps Script to Connect AI via the Query API, you need the following information:

* **URL**—*[https://cloud.cdata.com/api/query](https://cloud.cdata.com/api/query)*
* **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
* **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

<Steps>
  <Step>
    Log in to Apps Script ([https://script.google.com](https://script.google.com)).
  </Step>

  <Step>
    Create a new Apps Script project.
  </Step>

  <Step>
    Copy and paste the script below into the Apps Script project. This script connects your data source to the Query API and outputs the results to the Apps Script console.
    Change the following in the script:

    * Update `username` with your Connect AI username.
    * Update `password` with the PAT you generated in the prerequisites.
    * Update `query` with your database query.

    ```javascript expandable theme={null}
    function postQueryToAPI() {
     // Define the API endpoint and authentication
     const apiUrl = 'https://cloud.cdata.com/api/query';
     const username = 'CONNECT_CLOUD_USERNAME'; // Replace with your API username
     const password = 'CONNECT_CLOUD_PAT' // Replace with your API password or PAT
     
     // Define the query payload
     const queryPayload = {
         query: "SELECT * FROM [Snowflake1].[PUBLIC].[Account]"
     };
     
     // Options for the POST request
     const options = {
         method: 'POST',
         headers: {
             'Authorization': 'Basic ' + Utilities.base64Encode(username + ':' + password),
             'Content-Type': 'application/json'
         },
         payload: JSON.stringify(queryPayload) // Convert payload to JSON
     };
     
     try {
         // Send the POST request to the API
         const response = UrlFetchApp.fetch(apiUrl, options);
     
         // Parse the JSON response
         const jsonResponse = JSON.parse(response.getContentText());
     
         const schema = jsonResponse.results[0].schema;
         const rows = jsonResponse.results[0].rows;
     
        // Create a mapped result
         const parsedResults = rows.map(row => {
         let rowData = {};
         schema.forEach((column, index) => {
             rowData[column.columnLabel] = row[index];
         });
         return rowData;
         });
     
         // Log the response to check the result
         Logger.log('Parsed Results: ' + JSON.stringify(parsedResults, null, 2));
     } catch (e) {
         // Handle errors and log the message
         Logger.log('Error: ' + e.message);
     }
    }
    ```
  </Step>

  <Step>
    Name and save your Apps Script project.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Run the script.

    <Note>
      The first time you run the script, you need to authorize it to make external connections. Click **Review Permissions** and follow the prompts to grant the necessary permissions.
    </Note>
  </Step>

  <Step>
    The **Execution log** displays the query output as a JSON object:

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# Axios
Source: https://docs.cloud.cdata.com/en/Clients/Axios-Client

This page outlines the steps to connect Axios to your Connect AI account using the REST API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI with Axios

<Steps>
  <Step>
    Create a project directory, for example, `connect_cloud`.
  </Step>

  <Step>
    Open the terminal in the project directory and initialize a node project as follows:

    ```bash theme={null}
    npm init -y
    ```
  </Step>

  <Step>
    Install the Axios dependency in the project with the following command:

    ```bash theme={null}
    npm install axios
    ```
  </Step>

  <Step>
    In your project directory, create a file called `server.js` that contains the following code. Provide your Connect AI `username` and `pat` (the PAT you created in the prerequisites). You must also provide a `query` for your data, such as `SELECT * FROM Snowflake1.PUBLIC.Accounts`.

    ```javascript expandable theme={null}
    const axios = require('axios')
     const user = 'username'
     const pat = '***********************************';
     //Your API endpoint
     const url = 'https://cloud.cdata.com/api/query';
     //Your data to be sent in the POST request
     const data = {
     "query":"SELECT * FROM Snowflake1.PUBLIC.Accounts"
     };
     axios.post(url, data, {
         auth: {
             username: user,
             password: pat
         }
     })
     .then(response => {
         const rows = response.data.results[0].rows;
         const schema = response.data.results[0].schema;
         //Create an array of column names
         const columnNames = schema.map(col => col.columnName);
         //Loop through each row and log the column name with its value
         rows.forEach(row => {
             const rowObject = {};
             row.forEach((value, index) => {
                 const columnName = columnNames[index];
                 rowObject[columnName] = value;
             });
             console.log(rowObject);
         })
     })
     .catch(error => {
         console.error('Error:', error);
     });
    ```
  </Step>

  <Step>
    In the terminal, execute the following command to run the server:

    ```bash theme={null}
    node server.js
    ```

    The query results appear.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# Azure Data Factory
Source: https://docs.cloud.cdata.com/en/Clients/AzureDataFactory-Client

This page outlines the steps to connect Azure Data Factory to Connect AI. You can use either Connect AI Virtual SQL Server API or the Connect AI OData endpoint to connect. Note that the Virtual SQL Server API performs better for large datasets, while OData performs well with smaller datasets.

## Prerequisites for Connecting via Virtual SQL Server API

Before you connect via Virtual SQL Server API, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via Virtual SQL Server API

To establish a connection from Azure Data Factory to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Login to Azure Data Factory.
  </Step>

  <Step>
    If you have not yet created a Data Factory:

    * Click **Create** and enter your configuration information in each tab.
    * When you are finished entering information, click **Review + create** and then **Create** to save the Data Factory.
  </Step>

  <Step>
    Open Azure Data Factory Studio and select your Data Factory.
  </Step>

  <Step>
    In the **Factory Resources** section, highlight the **Datasets** option.
  </Step>

  <Step>
    Click the three dots to open the Dataset actions and select **New Dataset**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the search bar, enter *SQL Server* and select it when it appears.
  </Step>

  <Step>
    Enter a name for the server. In the **Linked service** field, select **New**.
  </Step>

  <Step>
    Enter the connection settings.

    * **Name**—enter a name of your choice.
    * **Server name**—enter the Virtual SQL Server endpoint and port separated by a comma: *tds.cdata.com*,*14333*
    * **Database name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **User Name**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—select **Password** (not **Azure Key Vault**) and enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
  </Step>

  <Step>
    Click **Create**.
  </Step>

  <Step>
    Select your new connection in the **Linked service** field.
  </Step>

  <Step>
    Select your desired table and click **OK**.
  </Step>
</Steps>

You can now use this Dataset when creating Data flows in Azure Data Factory.

## Prerequisites for Connecting via OData Endpoint

Before you connect to Connect AI via the OData endpoint, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Create a [Workspace](/en/Workspaces). Later, you will use the **OData Service URL** on that page (*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*) with the relevant workspace name to establish the connection.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via OData Endpoint

To connect to Connect AI using the OData protocol, follow these steps.

<Steps>
  <Step>
    Login to Azure Data Factory.
  </Step>

  <Step>
    Click **New** > **Dataset**.

    <Frame>
      <img alt="" />
    </Frame>

    A **New dataset** dialog appears.
  </Step>

  <Step>
    In the search bar, enter *OData*.

    <Frame>
      <img alt="" />
    </Frame>

    Select **OData** and click **Continue**.
  </Step>

  <Step>
    In the **Set properties** dialog, name your OData Resource and for **Linked service**, click **New**. A **New linked service** dialog appears.
  </Step>

  <Step>
    Enter the following settings for OData:

    * **Name**—enter a name of your choice.
    * **Service URL**—enter *[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*.
    * **Authentication type**—select **Basic Authentication**.
    * **User name**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—select **Password** (not **Azure Key Vault**) and enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Create**. This loads the details for your specific table or dataset that you want to query.
  </Step>

  <Step>
    In the tab for your new dataset, select the path for the data you want to view.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Preview data** to view the data.
  </Step>
</Steps>


# Azure Logic Apps
Source: https://docs.cloud.cdata.com/en/Clients/AzureLogicApps-Client

You can connect Azure Logic Apps to Connect AI via the OpenAPI specification.

## Prerequisites

Before you connect via OpenAPI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* [Add a workspace](/en/Workspaces#add-a-workspace) to Workspaces.
* [Add assets](/en/Workspaces#workspace-assets) to your workspace.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.
* Ensure that you have access to create a custom connector under your Azure subscription.

## Connect to Connect AI

To establish a connection from Azure Logic Apps to Connect AI via OpenAPI, follow these steps.

<Steps>
  <Step>
    In **Workspaces** in Connect AI, select a workspace and download the OpenAPI specification for the workspace. See [OpenAPI](/en/API/OpenAPI) for more information.

    <Note>
      You must use OpenAPI version 2.0 and select **Convert array types to strings**.
    </Note>

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Log in to your Azure portal.
  </Step>

  <Step>
    In Microsoft Azure, under **Azure services**, click **Create a resource**.
  </Step>

  <Step>
    In the search bar, type *Logic Apps Custom Connector*. Click **Create** > **Logic Apps Custom Connector**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter the details for your custom connector, and then click **Review + create**.

    <Frame>
      <img alt="" />
    </Frame>

    Refer to the [Microsoft documentation](https://learn.microsoft.com/en-us/connectors/custom-connectors/create-logic-apps-connector) for more details.
  </Step>

  <Step>
    In the Logic Apps custom connector you created, click **Edit**. You will now import the OpenAPI definition into the custom connector. Follow the steps below or refer to the [Microsoft documentation](https://learn.microsoft.com/en-us/connectors/custom-connectors/define-openapi-definition).
  </Step>

  <Step>
    Under **1. General**, select an **Import mode** of **OpenAPI file**. Then locate the OpenAPI definition you created.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter general information about the connector, including a description. **Host** and **Base URL** are already filled in.
  </Step>

  <Step>
    In the **2. Security** step, select an **Authentication type** of **Basic authentication**. Users have to provide a user name and password before using this API. Enter the parameter labels that users will see.

    <Note>
      When you use the custom connector, the user name is the Connect AI user name, and the password is the PAT created in the prerequisites.
    </Note>
  </Step>

  <Step>
    The **3. Definition** step of the connector defines all the actions of the connector that are contained in the OpenAPI specification file. The actions include all the functions you need for the table, including list, get, create, update, and delete records.
    In the **3. Definition** step, you can edit the **Actions** and **References** imported from the OpenAPI specification.

    * **Actions**—each action in the custom connector has **General** information, as well as the **Request**, **Response**, and **Validation** of the response.
      For example, the following request is a GET request to list drives.

    <Frame>
      <img alt="" />
    </Frame>

    The request includes query parameters that are appended to the URL, such as `$top`, `$filter`, and `$orderby`. You can edit and delete the query parameters here. The parameters are based on the OData protocol.
    See [API Operations](/en/API/OpenAPI#api-operations) for a complete reference.
    Similarly, there is a POST request to create a new record. The request contains all the fields for the record. You can edit these fields in the definition.

    * **References**—reusable parameters that are used by both actions and triggers. Each reference has a **Definition** and **Validation**.
  </Step>

  <Step>
    Click **Update connector** to save your changes.
  </Step>

  <Step>
    You can now build Logic Apps with your custom connector. For more information about building Logic Apps with a custom connector, refer to the [Microsoft documentation](https://learn.microsoft.com/en-us/connectors/custom-connectors/use-custom-connector-logic-apps).
  </Step>
</Steps>


# BI and Reporting Tools
Source: https://docs.cloud.cdata.com/en/Clients/BIReportingTools

Below is a list of the Business Intelligence (BI) and Reporting tools that connect to Connect AI:

* [Alteryx](/en/Clients/Alteryx-Client)
* [Amazon QuickSight](/en/Clients/AmazonQuickSight-Client)
* [Azure Analysis Services](/en/Clients/AAS-Client)
* [APOS](/en/Clients/APOS-Client)
* [Crystal Reports](/en/Clients/CrystalReports-Client)
* [Excel](/en/Clients/Excel365-Client)
* [Geckoboard](/en/Clients/Geckoboard-Client)
* [Google Sheets](/en/Clients/GoogleSheets-Client)
* [IBM Cognos Analytics](/en/Clients/IBMCognos-Client)
* [Looker](/en/Clients/Looker-Client)
* [Looker Studio](/en/Clients/LookerStudio-Client)
* [Metabase](/en/Clients/Metabase-Client)
* [Microsoft Fabric](/en/Clients/MicrosoftFabric-Client)
* [MicroStrategy](/en/Clients/MicroStrategy-Client)
* [Mode](/en/Clients/Mode-Client)
* [PowerBI.com](/en/Clients/PowerBI.com-Client)
* [Power BI Desktop](/en/Clients/PowerBIDesktop-Client)
* [Qlik Sense](/en/Clients/QlikSenseCloud-Client)
* [Redash](/en/Clients/Redash-Client)
* [SAP Analytics Cloud](/en/Clients/SAPAnalyticsCloud-Client)
* [SAS Viya](/en/Clients/SASViya-Client)
* [Tableau Cloud](/en/Clients/TableauCloud-Client)
* [Tableau Desktop](/en/Clients/TableauDesktop-Client)
* [ThoughtSpot](/en/Clients/ThoughtSpot-Client)
* [Zoho Analytics](/en/Clients/ZohoAnalytics-Client)


# Bubble
Source: https://docs.cloud.cdata.com/en/Clients/Bubble-Client

This page outlines the steps to connect Bubble to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Bubble to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Bubble.
  </Step>

  <Step>
    On the left hand menu, click **Plugins**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Add plugins**.
  </Step>

  <Step>
    Search for "SQL Database Connector" and click **Install**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Once it is installed, it is available to use as shown below. Click **Add a new connection**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter the connection settings.

    * **Connection name**—enter a name for the connection to Connect AI.
    * **Database type**—select **Microsoft SQL**.
    * **Connection string**—enter the SQL database connection string. This string includes a username and password in a format like `sql://[Username]:[Password]@tds.cdata.com:14333/`. Enter the following settings into this string.
      * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
      * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Note>
      The password portion of the connection string should not contain any forward slashes, because Bubble interprets them as separators. Replace any forward slashes with the URL-encoded string `%2F`.
    </Note>

    <Note>
      it is also possible to add a database connection name at the end of the connection string like `sql://[Username]:[Password]@tds.cdata.com:14333/[ConnectionName]`.
    </Note>

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Test the connection**. If the connection succeeds, this button becomes gray and says **Database connected** as shown below.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# CData Sync
Source: https://docs.cloud.cdata.com/en/Clients/CDataSync-Client

This page outlines the steps to connect CData Sync to your Connect AI account.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from CData Sync to Connect AI, follow these steps.

<Steps>
  <Step>
    Log in to CData Sync.
  </Step>

  <Step>
    In the navigation menu, select **Connections**. Click **Add Connection**.
  </Step>

  <Step>
    On the **Select Connectors** page, select the **Sources** tab, and enter *CData Connect* in the search field.

    <Note>
      Click the download icon to download the connector if it is not already installed.
    </Note>
  </Step>

  <Step>
    Click **CData Connect** to configure the connection. A **New Connection** page appears.
  </Step>

  <Step>
    Enter the following settings for your connection for your source data.

    * **Connection name**—enter the name of your connection for display purposes.
    * **Auth Scheme**—use **Basic**.
    * **User**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **URL**—Enter *`https://cloud.cdata.com/api`*.
    * **Default Catalog**—(optional) enter the name of your default catalog.
    * **Workspace**—(optional) enter the name of the workspace with which you want to connect.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Create & Test**. If the connection is successful, the Connect AI connection appears on the **Connections** page.
  </Step>
</Steps>

Now you need to configure your connection for your destination data. For this example, the destination data is a SQL Server database.

<Steps>
  <Step>
    In the navigation menu, select **Connections**. Click **Add Connection**.
  </Step>

  <Step>
    On the **Select Connectors** page, select the **Destinations** tab, and enter *SQL Server* in the search field.

    <Note>
      Click the download icon to download the destination connector if it is not already installed.
    </Note>
  </Step>

  <Step>
    Click **SQL Server** to configure the connection. A **New Connection** page appears.
  </Step>

  <Step>
    Enter the following settings for your connection for your destination data.

    <Note>
      For other destination connection configurations, see the [CData Sync documentation](https://cdn.cdata.com/help/ASM/sync/index.html).
    </Note>

    * **Connection name**—enter the name of your connection for display purposes.
    * **Server**—enter the host name or IP address of the server that hosts the SQL Server database. The default server is localhost.
    * **Port**—enter the port number for SQL Server. The default port value is 1433.
    * **Database**— enter the default database to which you want to connect when you connect to SQL Server.
    * **User**—enter the username that you use to authenticate to SQL Server.
    * **Password**—enter the password that you use to authenticate to SQL Server.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Create & Test**. If the connection is successful, the connection appears on the **Connections** page.
  </Step>
</Steps>

To add a job to CData Sync and run the job, follow these steps.

<Steps>
  <Step>
    In the navigation menu, select **Jobs**. Click **Add Job** > **Add New Job**.
  </Step>

  <Step>
    In the **Add Job** dialog, enter the following information.

    * **Name**—enter the name of the job for display purposes.
    * **Source**—select the Connect AI connection you created.
    * **Destination**—select the destination connection you created.
    * **Type**—select either **Standard** or **Sync All**.
  </Step>

  <Step>
    Click **Add Job**.
  </Step>

  <Step>
    In **Jobs**, click the new job you just created. In the **Task** tab, click **Add Tasks**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the **Select Schema** dialog, select the schema and table you want to replicate.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    The table is added as a task. Click **Run** to run the task.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    The table is replicated to your destination.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# Choreo
Source: https://docs.cloud.cdata.com/en/Clients/Choreo-Client

This page outlines the steps to connect Choreo to your Connect AI account.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI in Choreo

<Steps>
  <Step>
    Sign in to the [Choreo platform](https://console.choreo.dev/).
  </Step>

  <Step>
    Click **Manual Trigger** to create a program that you can execute manually.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter a **Name** and **Description** for the manual trigger and click **Create**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    The manual trigger opens in the **Develop** view.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Edit Code** to open the low-code diagram view.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Choreo automatically generates a construct in the low-code diagram view. Delete this construct by highlighting it and clicking the delete icon.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Choreo prompts you to create a new construct. Click the indicated button to open a list of options, then select **Main**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Save** in the settings pane that appears.
  </Step>

  <Step>
    The main construct appears in the diagram view. In the menu that appears under **Start**, click **Connector**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the **Connectors** dialog, search for *CData*. Click **CData Connect** to open the **Connector** settings pane.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the **Connector** settings pane, enter the configuration settings:

    * Enter an **Endpoint Name** for your use.
    * In the **User** field, enter the email address of the Connect AI user, wrapped in quotation marks (for example, *"[user@cdata.com](mailto:user@cdata.com)"*).
    * In the **Password** field, enter the [PAT you generated earlier](#prerequisites), wrapped in quotation marks (for example, *"SampleToken"*).

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Save Connection** to save your settings.
  </Step>
</Steps>

The Connect AI connector appears in both the low-code diagram view and the source code view of the code editor.

<Frame>
  <img alt="" />
</Frame>

You can now add connector Actions to your application logic.

## Use Connector Actions in Choreo

To add an Action to your application logic, click the **+** icon between the **new** and **End** nodes.

<Frame>
  <img alt="" />
</Frame>

In the menu that appears, click **Action**.

<Frame>
  <img alt="" />
</Frame>

The Connect AI connector supports the following operations:

* **query**—[query data](#query-action) from your data sources
* **queryRow**—query data from a single row of a data source
* **execute**—perform DML and DDL operations
* **batchExecute**—perform a batch of DML and DDL operations
* **call**—execute a stored procedure

For more information about working with these operations, see the [CData Connect Ballerina Guide](https://github.com/ballerina-platform/module-ballerinax-cdata.connect/blob/main/ballerina/Module.md#quickstart).

### Query Action

Follow these steps to configure a query action:

<Steps>
  <Step>
    Select **query** for the connector **Operation**.
  </Step>

  <Step>
    Enter your query in the **SqlQuery** box.

    * When writing the query, be sure to specify the **Connection Name** and **Data Source Name** of the data source you want to query. For example, `Salesforce1.Salesforce`.
    * These parameters appear on the [Sources](/en/Sources) page of your Connect AI dashboard.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Save** to save the action.
  </Step>
</Steps>

## Deploy the Program

Once you have added all of your desired actions to your program, follow these steps:

<Steps>
  <Step>
    Commit and push your final source code in the web editor and sync those changes with the Choreo platform.
  </Step>

  <Step>
    Click **Deploy** in the left navigation bar of the Choreo Console.
  </Step>

  <Step>
    Under **Build Area**, click **Configure & Deploy** to deploy your program.
  </Step>

  <Step>
    When prompted, enter the same Connect AI username and password that you used earlier and click **Deploy**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>

## More Information

For more information about using Choreo with Connect AI, see the [CData Connect Ballerina Guide](https://github.com/ballerina-platform/module-ballerinax-cdata.connect/blob/main/ballerina/Module.md#quickstart).


# FileMaker Pro
Source: https://docs.cloud.cdata.com/en/Clients/Claris-Client

This page outlines the steps to connect FileMaker Pro to Connect AI.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

### Connect from Mac

<Steps>
  <Step>
    Download and install the [Actual ODBC Driver for SQL Server](https://actualtech.com/product_sqlserver.php).
  </Step>

  <Step>
    Configure a DSN using the Actual ODBC driver by setting the following:

    * **URL**: [https://tds.cdata.com/](https://tds.cdata.com/)
    * **Port**: Change the port from 1433 to 14333
    * **Username**: your Connect AI email
    * **Password**: the PAT you created earlier
  </Step>
</Steps>

The FileMaker Pro SQL Query Builder requires customization to connect to Connect AI. Auto-generated queries do not work in FileMaker Pro. We recommend the following additional steps:

<Steps>
  <Step>
    In the SQL Query Builder **SELECT** tab, select the columns to include as part of the query.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Open the **WHERE** tab of the SQL Query Builder and select **Show only selected columns**.
  </Step>

  <Step>
    In **Table.Column**, select a table and a column name.
  </Step>

  <Step>
    Set the **Operator** to **=**.
  </Step>

  <Step>
    Select **Column**, and then select the same table and column name as **Table.Column**.
  </Step>

  <Step>
    Click **Insert into SQL Query**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    If no other modifications to the SQL query are required, click **Execute**.
  </Step>
</Steps>

### Connect from Windows

To establish a connection from FileMaker Pro to Connect AI, follow these steps.

<Steps>
  <Step>
    Download and install the Connect AI ODBC driver.

    * Open the **Integrations** page of Connect AI.
    * Search for **ODBC**.
    * Click **Download** and select your operating system.
    * When the download is complete, run the setup file.
    * When the installation is complete, the ConfigureODBC file can be found in the installation directory.
  </Step>

  <Step>
    Open the ConfigureODBC file.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the **Basic** tab, make sure the **Auth Scheme** is `OAuth`.
  </Step>

  <Step>
    In the **Advanced** tab, in **Miscellaneous** > **Default Catalog**, enter the name of the connection set up in the prerequisites.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Test Connection**. Click **OK** when you have a successful connection.
  </Step>

  <Step>
    Launch FileMaker Pro. A startup screen appears.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Start a blank app or use a template. Name your app.
  </Step>

  <Step>
    Select **File** > **Import Records** > **ODBC Data Source**. A **Select ODBC Data Source** dialog appears.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Select **Connect Source** and click **Continue**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter your user credentials in the dialog. The **User name** is your User Id in Connect AI, and the **Password** is the PAT obtained in the prerequisites.
  </Step>

  <Step>
    When the Connect AI data is finished importing, a **SQL Query Builder** dialog appears.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Select the tables and columns to insert into your SQL query and click **Execute**.
  </Step>

  <Step>
    A **Specify Import Order** dialog appears, where you can customize how and into which table you want to import the Connect AI data into FileMaker Pro.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Import** to import the data into the target FileMaker Pro file.
  </Step>

  <Step>
    You can now work with the data in FileMaker Pro.
  </Step>
</Steps>


# Cloud Data Fusion
Source: https://docs.cloud.cdata.com/en/Clients/CloudDataFusion-Client

This page outlines the steps to install and configure the Connect AI connector for Cloud Data Fusion. After installation, Cloud Data Fusion can pull data from sources that you have connected to your Connect AI account.

## Prerequisites

Before you can configure and use Cloud Data Fusion with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

You must also generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Cloud Data Fusion to Connect AI, follow these steps.

<Steps>
  <Step>
    Download and install the Connect AI JDBC driver.

    * Open the **Integrations** page of Connect AI.
    * Search for **JDBC** or **Cloud Data Fusion**.
    * Click **Download** and select your operating system.
    * When the download is complete, run the setup file.
    * When the installation is complete, the JAR file can be found in the installation directory.
  </Step>

  <Step>
    Log in to Cloud Data Fusion.
  </Step>

  <Step>
    Click the green "+" in the top right to add an entity.
  </Step>

  <Step>
    Under **Driver**, click **Upload**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Upload the Connect AI JDBC driver.
  </Step>

  <Step>
    Enter the driver settings.

    * **Name**—the name of the driver
    * **Class name**—enter *cdata.jdbc.connect.ConnectDriver*
    * **Version**—the driver version
    * **Description**—(optional) a description for the driver

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Finish**.
  </Step>

  <Step>
    Enter source configuration settings.

    * **Label**—to identify the connection
    * **JDBC driver name**—enter the JDBC driver name. This is to identify the driver configured in Step 6.
    * **Connection string**—the JDBC connection string. It is formatted like `jdbc:connect:AuthScheme=Basic;User=[User];Password=[Password];`. Fill in this string with the following parameters.
    * **User**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Validate** in the top right.
  </Step>

  <Step>
    If the connection succeeds, you can manage the pipeline by editing it through the UI.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>

## Troubleshooting

Please be aware that there is a known issue with Cloud Data Fusion where `int` types from source data are automatically cast as `long`.


# Crystal Reports
Source: https://docs.cloud.cdata.com/en/Clients/CrystalReports-Client

This page outlines two different ways to connect to Connect AI from Crystal Reports: through OData or through the JDBC driver. After installation, Crystal Reports can pull data from sources that you have connected to your Connect AI account.

<Note>
  The OData method of connecting is simpler and faster than the JDBC method.
</Note>

## Prerequisites

Before you can configure and use Crystal Reports with Connect AI through either method, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

You must also generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

**For OData connectivity only:** Create a [Workspace](/en/Workspaces). Later, you will use the **OData Service URL** on that page (*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*) with the relevant workspace name to establish the connection.

## Connect to Connect AI via OData

To establish a connection from Crystal Reports to Connect AI via OData, follow these steps.

<Steps>
  <Step>
    If necessary, download and install Crystal Reports from the SAP website.
  </Step>

  <Step>
    In Crystal Reports, select **File** > **New** > **Standard Report**.

    <Frame>
      <img alt="Crystal Reports New Report" />
    </Frame>
  </Step>

  <Step>
    In the **Standard Report Creation Wizard**, select **OData** as your data source.

    <Frame>
      <img alt="Crystal Reports Report Wizard" />
    </Frame>

    This opens the **OData** connectivity dialog.
  </Step>

  <Step>
    In the **OData** dialog, enter the following information:

    * **Service root URL**–*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*
    * **User ID**–enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**–enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="Crystal Reports OData" />
    </Frame>

    Click **Finish**.
  </Step>

  <Step>
    The tables in the selected workspace now appear as an available data source under OData.

    <Frame>
      <img alt="Crystal Reports Data Source" />
    </Frame>
  </Step>

  <Step>
    Select the tables and columns for your report.

    <Frame>
      <img alt="Crystal Reports Add Fields" />
    </Frame>
  </Step>

  <Step>
    Click **Finish** to generate the report.
  </Step>
</Steps>

## Connect to Connect AI via JDBC Driver

To establish a connection from Crystal Reports to Connect AI through the JDBC driver, follow these steps.

<Steps>
  <Step>
    If necessary, download and install Crystal Reports from the SAP website.
  </Step>

  <Step>
    Download and install the Connect AI JDBC driver.

    a. Open the **Integrations** page of Connect AI.

    b. In the **Dev Tools** section, click **JDBC**.

    c. Download and run the setup file.

    d. When the installation is complete, locate the JDBC Connect JAR file in the JDBC driver's installation directory, for example, `C:\Program Files\CData\JDBC Driver for CData Connect\lib`.

    e. Copy the JDBC Connect JAR file.
  </Step>

  <Step>
    Find the installation directory for Crystal Reports, for example, `C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java\lib`.
  </Step>

  <Step>
    Paste the JDBC Connect JAR file into the Crystal Reports installation directory.
  </Step>

  <Step>
    Go to the parent `java` folder (for example, `C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java`). This folder should contain a `CRConfig` file.

    <Frame>
      <img alt="Crystal Reports Client" />
    </Frame>
  </Step>

  <Step>
    Open `CRConfig` in a text editor.
  </Step>

  <Step>
    Add the path to the JDBC Connect JAR file in the `<Classpath>` of the `CRConfig` file, for example, `C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java\lib`.

    <Frame>
      <img alt="Crystal Reports Config" />
    </Frame>
  </Step>

  <Step>
    Log in to Crystal Reports and start a blank report.
  </Step>

  <Step>
    In the **Database Expert** dialog, click **Create New Connection**.
  </Step>

  <Step>
    Select the **JDBC** data source and the tables you want to add. Click **OK**.

    <Frame>
      <img alt="Crystal Reports Add Tables" />
    </Frame>
  </Step>

  <Step>
    In the **Connection** dialog, enter the **Connection URL** and **Database Classname**.

    <Frame>
      <img alt="Crystal Reports Connection" />
    </Frame>
  </Step>

  <Step>
    Click **Finish**. The **Database Expert** dialog displays all available connections.

    <Frame>
      <img alt="Crystal Reports Final" />
    </Frame>
  </Step>
</Steps>

You can now create reports with the connected data.


# Databricks
Source: https://docs.cloud.cdata.com/en/Clients/Databricks-Client

This page outlines the steps to configure Databricks to access Connect AI. Databricks can pull data from sources that you have connected to your Connect AI account.

## Prerequisites

Before you can configure and use Databricks with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

You must also generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Databricks to Connect AI, follow these steps.

<Steps>
  <Step>
    Download and install the Connect AI JDBC driver.

    <Steps>
      <Step>
        Open the **Integrations** page of Connect AI.
      </Step>

      <Step>
        Search for **JDBC** or **Databricks**.
      </Step>

      <Step>
        Click **Download** and select your operating system.
      </Step>

      <Step>
        When the download is complete, run the setup file.
      </Step>

      <Step>
        When the installation is complete, the JAR file can be found in the installation directory.
      </Step>
    </Steps>
  </Step>

  <Step>
    Log in to Databricks.
  </Step>

  <Step>
    In the navigation pane, select **Compute**. Start any compute or create a new one.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Once the compute is started, click the compute and then select the **Libraries** tab.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Install new**. The **Install library** dialog appears.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Select **DBFS**. Then drag and drop the JDBC JAR file into the indicated area. The file has the name *cdata.jdbc.connect.jar*. Click **Install**.
  </Step>

  <Step>
    You must now run three notebook scripts, one by one.
  </Step>

  <Step>
    The first script is below. Change the following:

    * Update `User` with your Connect AI username.
    * Update `Password` with the PAT you generated in the prerequisites.
    * Update `Your_Connection_name` with the name of the data source you created in the prerequisites.

    ```python theme={null}
    driver = "cdata.jdbc.connect.ConnectDriver"
    url ="jdbc:connect:AuthScheme=Basic;User=user@cdata.com;Password=***********;URL=https://cloud.cdata.com/api/;DefaultCatalog= Your_Connection_Name;"
    ```
  </Step>

  <Step>
    Run the first script.
  </Step>

  <Step>
    From the menu on the right side, select **Add cell below** to add a second script. The second script is below. Change the following:

    * Update `User` with your Connect AI username.
    * Update `Password` with the PAT you generated in the prerequisites.
    * Update `Your_Connection_name` with the name of the data source you created in the prerequisites.
    * Update `YOUR_SCHEMA.YOUR_TABLE` with your schema and table, for example, `PUBLIC.CUSTOMERS`.

    ```python theme={null}
    remote_table = spark.read.format ( "jdbc" ) \
    .option ( "driver" , "cdata.jdbc.connect.ConnectDriver") \
    .option ( "url","jdbc:connect:AuthScheme=Basic;User=user@cdata.com;Password=*******;URL=https://cloud.cdata.com/api/;DefaultCatalog= Your_Connection_Name;") \
    .option ( "dbtable" , "YOUR_SCHEMA.YOUR_TABLE") \
    .load ()
    ```
  </Step>

  <Step>
    Run the second script.
  </Step>

  <Step>
    Add a cell for the third script. The third script is below. Select the columns you want to display.

    ```python theme={null}
    display (remote_table.select ("ColumnName1","ColumnName2"))
    ```
  </Step>

  <Step>
    Run the third script.
  </Step>

  <Step>
    You can preview your data in Databricks.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# Databricks Lakehouse Federation
Source: https://docs.cloud.cdata.com/en/Clients/DatabricksLHF-Client

Databricks Lakehouse Federation allows for data virtualization without importing data into Databricks. Although Connect AI allows for data virtualization, there are some features, such as data lineage and fine-grained access control, that can benefit from being virtualized on Databricks. For more information on Databricks Lakehouse Federation, see the [Databricks documentation](https://www.databricks.com/blog/announcing-general-availability-lakehouse-federation).

Databricks Lakehouse Federation can pull data from sources that you have connected to your Connect AI account. This page outlines the steps to connect Databricks Lakehouse Federation to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Databricks Lakehouse Federation to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Databricks.
  </Step>

  <Step>
    In the navigation pane, select **Catalog**. Click **+** and select **Add a connection**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In **Create Connection**, enter the following:

    * **Connection name**—the user-defined connection name.
    * **Connection type**—select **SQL Server** from the drop-down list.
    * **Auth type**—select **Username and password**.
    * **Host**—*tds.cdata.com*
    * **Port**—*14333*
    * **User**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Test connection**. If the connection succeeds, a confirmation dialog appears.
  </Step>

  <Step>
    You now need to add the target database to the Catalog. In the navigation pane, select the connection you just created and click **Create catalog**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the **Create a new catalog** dialog, enter the following information,

    * **Catalog name**—enter a user-defined catalog name.
    * **Connection**—this is the Databricks connection you defined earlier and selected.
    * **Database**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Create**. If the catalog creation succeeds, a confirmation dialog appears. Click **View catalog** to view your new catalog.
  </Step>

  <Step>
    You can also return to **Catalog** in the navigation pane and find the catalog you just added. Expand the catalog to view the objects in the catalog.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Select a table and click the **Overview** tab to view table metadata.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click the **Sample Data** tab to view the real-time data in the table.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Go to **Dashboards** in the navigation pane to visualize the data.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# Dev Tools
Source: https://docs.cloud.cdata.com/en/Clients/DevTools

Below is a list of the development tools that connect to Connect AI:

* [ADO.NET](/en/Clients/ADO.NET-Client)
* [Apps Script](/en/Clients/AppsScript-Client)
* [Axios](/en/Clients/Axios-Client)
* [Choreo](/en/Clients/Choreo-Client)
* [Databricks](/en/Clients/Databricks-Client)
* [Databricks Lakehouse Federation](/en/Clients/DatabricksLHF-Client)
* [Grafana](/en/Clients/Grafana-Client)
* [JDBC](/en/Clients/JDBC-Client)
* [Node.js](/en/Clients/Nodejs-Client)
* [ODBC](/en/Clients/ODBC-Client)
* [Polybase](/en/Clients/Polybase-Client)
* [Python](/en/Clients/Python-Client)
* [SSIS](/en/Clients/SSIS-Client)
* [SQL Server Linked Server](/en/Clients/SQLServerLinked-Client)


# ETL Tools
Source: https://docs.cloud.cdata.com/en/Clients/ETLTools

Below is a list of the Extract, Transform, and Load (ETL) tools that connect to Connect AI:

* [Airbyte](/en/Clients/Airbyte-Client)
* [AWS Glue](/en/Clients/AWSGlue-Client)
* [Azure Data Factory](/en/Clients/AzureDataFactory-Client)
* [CData Sync](/en/Clients/CDataSync-Client)
* [Cloud Data Fusion](/en/Clients/CloudDataFusion-Client)


# Excel Functions
Source: https://docs.cloud.cdata.com/en/Clients/Excel-Client-Functions

The CData Connect Spreadsheets add-in for Excel includes support for several Excel functions. A *function* is a preset formula that helps perform different operations and data analysis faster. You can use these functions to execute stored procedures.

Functions perform specific calculations in a particular order based on the specified values, called *arguments* or parameters. Function parameters can refer to specific cells; as these cell values change, the add-in automatically refreshes the results.

Since Excel functions are stored within the Excel file, you can share your dynamic spreadsheets with others. In addition, they eliminate time-consuming manual entry of formulas. You can perform your tasks efficiently and save time.

## CDATACONNECT.QUERY

*=CDATACONNECT.QUERY(query, connection, \[defaultCatalog], \[defaultSchema], \[paramsRange] \[options])*

It contains the following parameters:

| **Parameter** | **Description** |
| :- | :- |
| query | A string containing the SQL query (or other statement) to execute. This should be in quotes. For example: |
| | `"SELECT * FROM [MailChimp2].[MailChimp].[Automations]"` |
| connection | A string containing the complete connection string or profile name. This is in quotes. For example: |
| | `"Connection=MailChimp2,Schema=MailChimp,Table=Automations"` |
| \[defaultCatalog] | A string containing the default catalog to use. This can be left blank. |
| \[defaultSchema] | A string containing the default schema to use. This can be left blank. |
| \[paramsRange] | The Parameters argument specifies the range of cells that contains the names and values for the parameters. The first row of the range is a header row and specifies the parameter names. For example, if the range A10:B11 contains the parameters, then the cells A10:B10 should contain the parameter names, and the cells A11:B11 should contain the parameter values. |
| \[options] | A string containing additional options to control the formula’s behavior, such as “header=false” to return the data without headers. |

The following is an example of a complete CDATACONNECT.QUERY function:

```excel theme={null}
=CDATACONNECT.QUERY("SELECT * FROM [SQLServer1].[dbo].[ImportantDataTypes]", "Connection=SQLServer1,Schema=dbo,Table=ImportantDataTypes", "", "", A1:F2)
```

The results appear just below the cell where the formula was entered.

<Note>
  CData Excel functions can be used with implicit cell references such as `E2`, `E$2`, or `Sheet1!E2`. However, since CData functions include the actual SQL statement as an argument to the function, passed as a string using double quotes, the cell reference needs to be passed outside of the quotation marks. The best way to achieve this is to use the `&` operator. This operator concatenates expressions in an Excel function.

  The following example shows a SQL statement with a WHERE clause referencing a dynamic cell reference:

  ```
  SELECT * FROM Salesforce1.Salesforce.Contact WHERE Contact__c = 'Sheet1!N2'
  ```

  This SQL statement must be entered as follows in a CData Excel function:

  ```excel theme={null}
  =@CDATACONNECT.QUERY("SELECT * FROM Salesforce1.Salesforce.Contact WHERE Contact__c = '"&Sheet1!N2&"'", "Connection=Salesforce1,Schema=Salesforce,Table=Contact")
  ```
</Note>

## CDATACONNECT.INSERT

*=CDATACONNECT.INSERT(data, connection, \[columnHeaders])*

| **Parameter** | **Description** |
| :- | :- |
| data | The range of rows to insert, such as A1:F14. The first row must contain the column headers unless they are specified in the ColumnHeaders argument; if you set ColumnHeaders, set only the column values in the data argument. |
| connection | A string containing the complete connection string or profile name. This is in quotes. For example: |
| | `"Connection=MailChimp2,Schema=MailChimp,Table=Automations"` |
| \[columnHeaders] | The columnHeaders argument specifies the range of cells that contains the column headers. The columnHeaders argument only needs to be specified if the column headers are not in the first row of data. You can also use the columnHeaders argument to specify the orientation of the data table: If the column headers are located in a vertical array, such as B20:B30, then each column is inserted as a row into the chosen table. |

The following formula inserts rows into the sheet:

```excel theme={null}
=CDATACONNECT.INSERT(K35:Q40,"Connection=SQLServer1,Schema=dbo,Table=ImportantDataTypes"",A1:G1)
```

## CDATACONNECT.UPDATE

*=CDATACONNECT.UPDATE(data, connection, \[columnHeaders])*

| **Parameter** | **Description** |
| :- | :- |
| data | The range of rows to update, such as J15:L15. The first row must contain the column headers unless they are specified in the ColumnHeaders argument; if you set ColumnHeaders, set only the column values in the data argument. |
| connection | A string containing the complete connection string or profile name. This is in quotes. For example: |
| | `"Connection=MailChimp2,Schema=MailChimp,Table=Automations"` |
| \[columnHeaders] | The columnHeaders argument specifies the range of cells that contains the column headers. The columnHeaders argument only needs to be specified if the column headers are not in the first row of data. You can also use the columnHeaders argument to specify the orientation of the data table: If the column headers are located in a vertical array, such as B20:B30, then each column is updated as a row into the chosen table. |

The following formula updates the record in row 15 of the sheet:

```excel theme={null}
=CDATACONNECT.UPDATE(A15:K15,"Connection=SQLServer1,Schema=dbo,Table=ImportantDataTypes"",J1:L1)
```

## CDATACONNECT.DELETE

*=CDATACONNECT.DELETE(data, connection, \[columnHeaders])*

It contains the following parameters:

| **Parameter** | **Description** |
| :- | :- |
| data | The range of rows to delete, such as J15:L15. The first row must contain the column headers unless they are specified in the ColumnHeaders argument; if you set ColumnHeaders, set only the column values in the data argument. |
| connection | A string containing the complete connection string or profile name. This is in quotes. For example: |
| | `"Connection=MailChimp2,Schema=MailChimp,Table=Automations"` |
| \[columnHeaders] | The columnHeaders argument specifies the range of cells that contains the column headers. The columnHeaders argument only needs to be specified if the column headers are not in the first row of data. You can also use the columnHeaders argument to specify the orientation of the data table: If the column headers are located in a vertical array, such as B20:B30, then each column is updated as a row into the chosen table. |

The following formula deletes the record in row 14 of the sheet:

```excel theme={null}
=CDATACONNECT.DELETE(A15:K15,"Connection=SQLServer1,Schema=dbo,Table=ImportantDataTypes"",A1:K1)
```


# Excel
Source: https://docs.cloud.cdata.com/en/Clients/Excel365-Client

This page outlines the steps to install and configure the CData Connect Spreadsheets add-in for Excel, including Excel desktop and Excel for the web. After installation, Excel is able to pull data from sources that you have connected to your CData Connect Spreadsheets account.

## Prerequisites

Before you can configure and use Excel with CData Connect Spreadsheets, you must first connect a data source to your CData Connect Spreadsheets account. See [Set Up Connection](#set-up-connection) for more information.

**Connect AI customers only:** You can also import Workspaces and Derived Views. To create a workspace, follow the instructions in [Workspaces](/en/Workspaces#add-a-workspace). To create a derived view (administrators only), follow the instructions in [Creating a Derived View](/en/Data-Explorer#create-a-derived-view).

## Install the Add-In

You can install the Excel add-in from the [CData Connect Spreadsheets dashboard](#from-the-cdata-connect-spreadsheets-dashboard) or from [Excel](#from-microsoft-excel).

### From the CData Connect Spreadsheets Dashboard

<Steps>
  <Step>
    Open the **Integrations** page of the dashboard.
  </Step>

  <Step>
    Locate the **Excel** tile or use the search bar.
  </Step>

  <Step>
    Click **Get Started**. The Excel add-in page opens.
  </Step>

  <Step>
    Click **Get it now**. If you are prompted, sign into your Microsoft account.
  </Step>

  <Step>
    On the **Launch** page, click **try using Office Online** (for Excel for the web).

    <Frame>
      <img alt="Excel 365 Switch" />
    </Frame>

    Then, click **Open in Excel Online**.
    If you are using Excel desktop, click **Open in Excel**.

    <Frame>
      <img alt="Excel Download Online" />
    </Frame>
  </Step>

  <Step>
    Authorize the add-in if you are prompted to do so.
  </Step>

  <Step>
    In either version of Excel, open a workbook or create a new workbook.
  </Step>

  <Step>
    Click **Add-ins** on the **Home** tab of the navigation ribbon. The **My Add-ins** window opens.

    <Frame>
      <img alt="Excel My Add-in" />
    </Frame>
  </Step>

  <Step>
    Continue to the steps in [Connect to CData Connect Spreadsheets](#connect-to-cdata-connect-spreadsheets).
  </Step>
</Steps>

### From Microsoft Excel

<Steps>
  <Step>
    Open Microsoft Excel (desktop or web) to a new or existing workbook.
  </Step>

  <Step>
    Click the **File** tab on the navigation ribbon.
  </Step>

  <Step>
    Click **Get Add-ins**. In the list of add-ins that appear, click **More Add-ins**.
  </Step>

  <Step>
    Search for *CData* in the window. In the search results, click **Add** next to **CData Connect Spreadsheets**.

    <Frame>
      <img alt="Excel Add-in Store" />
    </Frame>
  </Step>

  <Step>
    Click **Continue** to agree to the license terms. An authorization dialog opens in your Excel workbook.
  </Step>

  <Step>
    Click **Authorize**.
  </Step>

  <Step>
    Enter your credentials and click **Continue** in the dialog.
  </Step>

  <Step>
    Continue to the steps in [Connect to CData Connect Spreadsheets](#connect-to-cdata-connect-spreadsheets).
  </Step>
</Steps>

## Connect to CData Connect Spreadsheets

After you install the Excel add-in, follow these steps to connect to your CData Connect Spreadsheets account:

<Steps>
  <Step>
    Open the **Data** tab on the Excel navigation ribbon and click **CData Connect Spreadsheets**.

    <Frame>
      <img alt="Excel Add-in Get Data" />
    </Frame>
  </Step>

  <Step>
    Authorize the CData Connect Spreadsheets add-in.
    The CData add-in pane appears to the right of your Excel workbook.

    <Frame>
      <img alt="Connect Spreadsheets Full" />
    </Frame>
  </Step>
</Steps>

## Set Up Connection

If you do not yet have the data connection you need for CData Connect Spreadsheets, you need to set one up.

<Steps>
  <Step>
    In the add-in pane, click **Connections**. Click **Add Connection**.
  </Step>

  <Step>
    Select the connector for the data you want to connect to Excel.
  </Step>

  <Step>
    Enter your data connection settings. Save and test your connection.
    After you have a successful connection, you can [Import Data](#import-data).
  </Step>
</Steps>

<Note>You can also use the **Connections** option to edit existing connections.</Note>

## Import Data

To import data from CData Connect Spreadsheets to Excel, follow these steps:

<Steps>
  <Step>
    Click **Import**.
  </Step>

  <Step>
    Select an option from the drop down menu: **Connections**, **Workspaces**, or **Derived Views**. Then follow the directions for the option you selected.
  </Step>
</Steps>

<Note>
  Only Connect AI customers can access workspaces and derived views.
</Note>

### Import Connections

<Steps>
  <Step>
    Select a connection from the drop-down list.
  </Step>

  <Step>
    Select either **Query Builder** to build the query in steps or **Custom SQL** to enter a query manually.

    * For Query Builder, select a schema (if there are multiple schemas), table, and columns. You can search by column name. If desired, you can also set [filters](#filters), [sorting options](#sorting), and limits. View the generated query and adjust if necessary.
    * For Custom SQL, enter the SQL Statement in the provided field.

    <Frame>
      <img alt="Excel Add-in Search Columns" />
    </Frame>
  </Step>

  <Step>
    Click **Execute**.
  </Step>

  <Step>
    When prompted, choose to output the data in either the current spreadsheet or a new one.
  </Step>
</Steps>

### Import Workspaces (Connect AI Customers Only)

<Steps>
  <Step>
    Select a workspace from the drop-down list.
  </Step>

  <Step>
    Select **Query Builder** to build the query in steps or select **Custom SQL** to enter a query manually.

    * For Query Builder, select a workspace and the columns to display. You can search by column name. If desired, you can also set [filters](#filters), [sorting options](#sorting), and limits. View the generated query and adjust if necessary.
    * For Custom SQL, enter the SQL Statement in the provided field.
  </Step>

  <Step>
    Click **Execute**.
  </Step>

  <Step>
    When prompted, choose to output the data in either the current spreadsheet or a new one.
  </Step>
</Steps>

### Import Derived Views (Connect AI Customers Only)

<Steps>
  <Step>
    Select **Query Builder** to build the query in steps or select **Custom SQL** to enter a query manually.

    * For Query Builder, select a workspace and the columns to display. You can search by column name. If desired, you can also set [filters](#filters), [sorting options](#sorting), and limits. View the generated query and adjust if necessary.
    * For Custom SQL, enter the SQL Statement in the provided field.
  </Step>

  <Step>
    Click **Execute**.
  </Step>

  <Step>
    When prompted, choose to output the data in either the current spreadsheet or a new one.
  </Step>
</Steps>

## Refresh Data

Once your data is imported, you can set it to periodically refresh automatically. You can also perform a manual refresh of your spreadsheet data. The automatic refresh overwrites any uncommitted data. If you are only reading data, the automatic update is not an issue. If you have enabled auto refresh and are writing data, commit your changes often with the **Update** button.

You must have the Excel workbook open in the browser in order for the automatic refresh to work properly. In addition, the automatic refresh will not execute if the workbook is idle for over 15 minutes.

<Steps>
  <Step>
    On the **CData Connect Spreadsheets** screen, select **Refresh**.
  </Step>

  <Step>
    Select the data sheet or sheets to refresh.

    <Frame>
      <img alt="Excel Refresh 01" />
    </Frame>
  </Step>

  <Step>
    To manually refresh, click **Refresh Now**. To set up automatic updates, click **Auto Refresh**.

    <Frame>
      <img alt="Excel Refresh 02" />
    </Frame>
  </Step>
</Steps>

<Note>
  Note that the refresh interval is set in hours, and one hour is the minimum interval between refreshes. If the auto-refresh fails, the Excel add-in will attempt the auto-refresh two more times. After the third fail, the next auto-refresh attempt will occur at the next user set interval.
</Note>

You can also remove a query or queries from the refresh list by selecting the query and clicking **Remove**.

## Update Data

You can push changes from the Excel spreadsheet to the originating data source. Note that in order to update a spreadsheet, the data must contain at least one primary key. You must also have the proper permissions to update the source data.

Be sure to update your data frequently if you are using the auto refresh feature, or your changes may be overwritten.

<Note>
  CData Connect Spreadsheets does not support updates for views (only tables).
</Note>

To update data in your spreadsheet, follow these steps:

<Steps>
  <Step>
    Make your changes to the Excel spreadsheet.
  </Step>

  <Step>
    On the **CData Connect Spreadsheets** add-in pane, click **Update**. You can choose to update the entire spreadsheet or just the selected rows. Click **Confirm**.
  </Step>
</Steps>

## Delete Data

<Note>
  CData Connect Spreadsheets does not support deletion for views (only tables).
</Note>

To delete rows from a spreadsheet, follow these steps:

<Steps>
  <Step>
    If necessary, return to the main menu of the CData Connect Spreadsheets add-in.
  </Step>

  <Step>
    Select the record(s) to delete.
  </Step>

  <Step>
    On the **CData Connect Spreadsheets** add-in pane, click **Delete**. Click **Confirm**.
  </Step>
</Steps>

## Logs

Click **Logs** to open a dialog that lists the most recent queries, including:

* The time and date they occurred
* Their results (success or failure)
* The contents and parameters of the queries

See [Logs](/en/Logs) for more information.

## Settings

Click [**Settings**](/en/Settings) to view and manage your profile, account details, and subscription.

## Advanced Query Settings

When importing data, you can use [Filters](#filters) and [Sorting](#sorting) to build your query. For SQL queries, you can use the advanced options [Parameterized Queries](#write-parameterized-queries) and [Searchable Spreadsheets](#create-searchable-spreadsheets).

### Filters

To add a filter, click the **+** next to the **Filters** header. You can add more filters by clicking the **+** again, and you can delete a filter by clicking the trash can icon next to it.

<Frame>
  <img alt="Excel 365 Filter" />
</Frame>

Each filter has three fields to fill out:

* **Column**—select the column from your table that you want to filter.
* **Operator**—the operation the filter performs. Options are *equals*, *does not equal*, *contains*, *does not contain*, *less than*, *less than or equal to*, *greater than*, and *greater than or equal to*.
* **Value**—the value for the filter operation.

For example, if you wanted to retrieve AccountValues above \$100,000, you might set the Column to *AccountValues*, the Operator to *greater than*, and the Value to *100,000*. Then, when you execute the query, only results matching this filter will be returned.

As you enter your filter parameters, the **Generated Query** at the bottom of the pane automatically updates.

### Sorting

To add a sorting rule to your query results, click the **+** next to the **Sort By** header. You can add more sorting rules by clicking the **+** again, and you can delete a sorting rule by clicking the trash can icon next to it.

<Frame>
  <img alt="Excel 365 Sort" />
</Frame>

Each sorting rule requires a **Column** and a sorting **Order** (ascending or descending). If you add multiple sorting rules, the results are sorted in the order that the rules appear. The query gives highest sorting priority to the first rule, then the second rule, etc.

As you enter your sorting parameters, the **Generated Query** at the bottom of the pane automatically updates.

### Write Parameterized Queries

You can create dynamic spreadsheets by referencing cells in your custom SQL statement. The Excel add-in executes the statement as a parameterized query. As you change the values in the sheet, the Excel add-in executes a new query.

### Create Searchable Spreadsheets

Use a parameterized SELECT WHERE query to create a spreadsheet that dynamically filters the data as you edit cells. The following filter criteria references the `@InputSheet!A2` parameter, which is cell `A2` of the sheet `InputSheet`. The `@` prefix indicates that `Industry` is a required parameter.

```bash theme={null}
SELECT BillingState, Name FROM Account WHERE Industry = @InputSheet!A2
```


# Geckoboard
Source: https://docs.cloud.cdata.com/en/Clients/Geckoboard-Client

This page outlines the steps to connect Geckoboard to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Geckoboard to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Geckoboard.
  </Step>

  <Step>
    Click **Add widget**.

    <Frame>
      <img alt="Geckoboard Client 01" />
    </Frame>
  </Step>

  <Step>
    Search for "Databases" and click the resulting option.

    <Frame>
      <img alt="Geckoboard Client 02" />
    </Frame>
  </Step>

  <Step>
    Select **SQL Server** as the database type.

    <Frame>
      <img alt="Geckoboard Client 03" />
    </Frame>
  </Step>

  <Step>
    Fill in the connection details:

    * **Connection name**—enter a name for the connection to Connect AI.
    * **Host**—enter *tds.cdata.com*
    * **Port**—enter *14333*
    * **Database name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="Geckoboard Client 04" />
    </Frame>
  </Step>

  <Step>
    Click **Connect**.
  </Step>
</Steps>


# Google Sheets
Source: https://docs.cloud.cdata.com/en/Clients/GoogleSheets-Client

This page outlines the steps to install and configure the CData Connect Spreadsheets add-on for Google Sheets. After installation, Google Sheets is able to pull data from sources that you have connected to your CData Connect Spreadsheets account.

## Prerequisites

Before you can configure and use Google Sheets with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

**Connect AI Customers Only:** You can also import Workspaces and Derived Views. To create a workspace, follow the instructions in [Workspaces](/en/Workspaces). To create a derived view (administrators only), follow the instructions in [Create a Derived View](/en/Data-Explorer#create-a-derived-view).

## Installation and Setup

<Steps>
  <Step>
    Sign in to [Google Sheets](https://docs.google.com/spreadsheets/) and either open a spreadsheet or create a new spreadsheet.
  </Step>

  <Step>
    With a spreadsheet open, select **Extensions** > **Add-ons** > **Get add-ons**.

    <Frame>
      <img alt="Sheets Get Add-on" />
    </Frame>
  </Step>

  <Step>
    Search for *CData* in the search bar and click the **CData Connect Spreadsheets** add-on.

    <Frame>
      <img alt="Google Sheets Marketplace" />
    </Frame>
  </Step>

  <Step>
    Click **Install** and then **Continue** on the pop-up.
  </Step>

  <Step>
    Select your Google account and sign in if needed. When prompted to approve the connection, click **Allow**.
  </Step>

  <Step>
    Return to the spreadsheet. Select **Extensions** > **CData Connect Spreadsheets** > **Open**.
  </Step>

  <Step>
    The configuration pane appears to the right of your spreadsheet. Click **Authorize** to sign in to CData Connect Spreadsheets.
  </Step>

  <Step>
    Enter your CData Connect Spreadsheets credentials and click **Continue**.
  </Step>

  <Step>
    When a success message appears, close the tab and return to Google Sheets.
  </Step>
</Steps>

After you establish a connection, the CData Connect Spreadsheets navigation menu appears:

<Frame>
  <img alt="Connect Spreadsheets Full" />
</Frame>

## Set Up Connection

If you do not yet have the data connection you need for CData Connect Spreadsheets, you need to set one up.

<Steps>
  <Step>
    In the add-in pane, click **Connections**. Click **Add Connection**.
  </Step>

  <Step>
    Select the connector for the data you want to connect to Google Sheets. Use the **Search** field to find the connector.
  </Step>

  <Step>
    Enter your data connection settings by following the instructions on the connection page. Save and test your connection.
    After you have a successful connection, you can [Import Data](#import-data).
  </Step>
</Steps>

<Note>You can also use the **Connections** option to edit existing connections.</Note>

## Import Data

To import data from a data connection, follow these steps:

<Steps>
  <Step>
    Click **Import**.
  </Step>

  <Step>
    Select an option from the drop-down menu: **Connections**, **Workspaces**, or **Derived Views**. Then follow the directions for the option you selected.
  </Step>
</Steps>

<Note>
  Only Connect AI customers can access workspaces and derived views.
</Note>

### Import Connections

<Steps>
  <Step>
    Select a **Connection** from the drop-down list.
  </Step>

  <Step>
    Select either **Query Builder** or **Custom SQL**.

    * For Query Builder, select a schema (if there are multiple schemas), table, and columns. If desired, you can also set [filters](#filters), [sorting options](#sorting), and limits. View the generated query and adjust if necessary.
    * For Custom SQL, enter the SQL Statement in the provided field.
  </Step>

  <Step>
    Click **Execute**.

    <Frame>
      <img alt="Sheets Query Builder" />
    </Frame>
  </Step>

  <Step>
    When prompted, choose to output the data in either the current spreadsheet or a new one.
  </Step>
</Steps>

### Import Workspaces (Connect AI Customers Only)

<Steps>
  <Step>
    Select a workspace from the drop-down list.
  </Step>

  <Step>
    Select either **Query Builder** or **Custom SQL**.

    * For Query Builder, select a workspace and the columns to display. If desired, you can also set [filters](#filters), [sorting options](#sorting), and limits. View the generated query and adjust if necessary.
    * For Custom SQL, enter the SQL Statement in the provided field.
  </Step>

  <Step>
    Click **Execute**.
  </Step>

  <Step>
    When prompted, choose to output the data in either the current spreadsheet or a new one.
  </Step>
</Steps>

### Import Derived Views (Connect AI Customers Only)

<Steps>
  <Step>
    Select either **Query Builder** or **Custom SQL**.

    * For Query Builder, select a derived view and the columns to display. If desired, you can also set [filters](#filters), [sorting options](#sorting), and limits. View the generated query and adjust if necessary.
    * For Custom SQL, enter the SQL Statement in the provided field.
  </Step>

  <Step>
    Click **Execute**.
  </Step>

  <Step>
    When prompted, choose to output the data in either the current spreadsheet or a new one.
  </Step>
</Steps>

## Refresh Data

The Google Sheets add-on allows you to refresh a query immediately or at a specified interval. To update the imported data in your spreadsheets from the originating source:

<Steps>
  <Step>
    Click **Refresh** in the main menu of the CData Connect Spreadsheets add-on. (Click the back arrow to return to the main menu of the add-on, if necessary.) The Refresh pane displays each query and its auto-refresh interval (if applicable).
  </Step>

  <Step>
    Select the checkboxes next to the queries that you want to update.

    <Frame>
      <img alt="Queries Refresh" />
    </Frame>
  </Step>

  <Step>
    Select a refresh option:

    * Click **Refresh Now** to manually refresh the data as soon as possible.
    * Click **Auto Refresh** to open a dialog where you can select the auto-refresh interval in hours for the selected query.

    <Note>You cannot refresh a query until the current refresh is complete.</Note>
  </Step>

  <Step>
    If you select **Refresh Now**, the data refreshes immediately. If you select **Auto Refresh**, the query updates at the interval you specified.
  </Step>
</Steps>

<Note>To edit a query, click **Edit** next to the query name. To remove a query, click **Remove** next to the query name. To change the auto-refresh interval for a query, select the query, click **Auto Refresh**, and update the interval in the dialog. To stop auto-refresh for a query, select the query, click **Auto Refresh**, and click **Remove** in the dialog.</Note>

## Update Data

You can push changes from the Google Sheets spreadsheet to the originating data connection. Note that in order to update a spreadsheet, the data must contain at least one primary key. You must also have the proper permissions to update the source data. You cannot update read-only fields in the originating data connection.

Be sure to update your data frequently if you are using the auto-refresh feature, or your changes may be overwritten by the originating data connection.

<Note>
  CData Connect Spreadsheets does not support updates for views (only tables).
</Note>

To update data in your spreadsheet, follow these steps:

<Steps>
  <Step>
    Make your changes to the Google Sheets spreadsheet. When you update data, the data is highlighted in red to signify that it is not yet updated to the originating data connection.
  </Step>

  <Step>
    If you want to update only select rows, highlight the cells or rows to be updated.
  </Step>

  <Step>
    On the **CData Connect Spreadsheets** add-on pane, click **Update**.
  </Step>

  <Step>
    Determine whether you want to **Update Selected** rows or **Update All**.
  </Step>

  <Step>
    Click **Execute**. Click **Confirm** to continue. This action updates the originating data connection and cannot be undone.
  </Step>

  <Step>
    CData Connect Spreadsheets returns a message whether the update was successful. If unsuccessful, CData Connect Spreadsheets displays the reason the update failed.
  </Step>

  <Step>
    If the update is successful, the data in red turns black. This indicates that the data is updated in the originating data connection.
  </Step>
</Steps>

## Insert Data

To insert a row or rows in a spreadsheet, follow these steps:

<Steps>
  <Step>
    If necessary, return to the main menu of the CData Connect Spreadsheets add-on.
  </Step>

  <Step>
    Use the Google Sheets function to insert rows in your spreadsheet (**Insert** > **Rows**).
  </Step>

  <Step>
    Enter the information into the row or rows. When you add data, the data is highlighted in red to signify that it is not yet updated to the originating data connection.
  </Step>

  <Step>
    If you want to update only the inserted row(s), highlight the row(s).
  </Step>

  <Step>
    On the **CData Connect Spreadsheets** add-on pane, click **Update**.
  </Step>

  <Step>
    Determine whether you want to **Update Selected** rows or **Update All**.
  </Step>

  <Step>
    Click **Execute**. Click **Confirm** to continue. This action inserts the data into the originating data connection and cannot be undone.
  </Step>

  <Step>
    CData Connect Spreadsheets returns a message whether the insertion was successful. If unsuccessful, CData Connect Spreadsheets displays the reason the insertion failed.
  </Step>

  <Step>
    If the insertion is successful, the data in red turns black. This indicates that the data is updated in the originating data connection.
  </Step>
</Steps>

## Delete Data

<Note>
  CData Connect Spreadsheets does not support deletion for views (only tables).
</Note>

To delete rows from a spreadsheet, follow these steps:

<Steps>
  <Step>
    If necessary, return to the main menu of the CData Connect Spreadsheets add-on.
  </Step>

  <Step>
    Select the rows you want to delete and click **Delete**. You can select any cell(s) in the row and CData Connect Spreadsheets deletes the entire row. CData Connect Spreadsheets prompts if you are sure you want to delete the given number of rows.
  </Step>

  <Step>
    Click **Confirm** to continue with the deletion. CData Connect Spreadsheets displays whether it deleted the rows successfully.
  </Step>
</Steps>

<Note>
  You cannot undo the row deletion.
</Note>

## Logs

Click **Logs** to open a dialog that lists the most recent queries, including:

* The time and date they occurred
* Their results (success or failure)
* The contents and parameters of the queries

See [Logs](/en/Logs) for more information.

## Advanced Query Settings

When importing data, you can use [Filters](#filters) and [Sorting](#sorting) to build your query.

### Filters

To add a filter, click the **+** next to the **Filters** header. You can add more filters by clicking the **+** again, and you can delete a filter by clicking the trash can icon next to it.

<Frame>
  <img alt="Sheets Filter" />
</Frame>

Each filter has three fields to fill out:

* **Column**—select the column from your table that you want to filter.
* **Op**—the operation the filter performs. Options are *equals*, *does not equal*, *contains*, *does not contain*, *less than*, *less than or equal to*, *greater than*, and *greater than or equal to*.
* **Value**—the value for the filter operation.

For example, if you wanted to retrieve AccountValues above \$100,000, you might set the Column to *AccountValues*, the Op to *greater than*, and the Value to *100,000*. Then, when you execute the query, only results matching this filter will be returned.

As you enter your filter parameters, the **Generated Query** at the bottom of the pane automatically updates.

### Sorting

To add a sorting rule to your query results, click the **+** next to the **Sort By** header. You can add more sorting rules by clicking the **+** again, and you can delete a sorting rule by clicking the trash can icon next to it.

<Frame>
  <img alt="Sheets Sort" />
</Frame>

Each sorting rule requires a **Column** and a sorting **Order** (ascending or descending). If you add multiple sorting rules, the results are sorted in the order that the rules appear. The query gives highest sorting priority to the first rule, then the second rule, etc.

As you enter your sorting parameters, the **Generated Query** at the bottom of the pane automatically updates.


# Grafana
Source: https://docs.cloud.cdata.com/en/Clients/Grafana-Client

This page outlines the steps to connect Grafana to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Grafana to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Download and install Grafana for your operating system from the [Grafana website](https://www.grafana.com/).
  </Step>

  <Step>
    Once installed, access Grafana at `http://localhost:3000/`.
  </Step>

  <Step>
    Log in to Grafana with your username and password for Grafana. If this is your first time logging in, the username is *admin* and the password is *admin*.
  </Step>

  <Step>
    On the navigation menu, click **Connections** > **Add new connection**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Search for **Microsoft SQL Server** as your data source.
  </Step>

  <Step>
    Click **Add new data source**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    (Optional) Enter a new name for the data source.
  </Step>

  <Step>
    Enter the following connection settings.

    * **Host**—*tds.cdata.com*:*14333*
    * **Database**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Save & test**. A **Database Connect OK** message appears.
  </Step>

  <Step>
    On the navigation menu, click **Explore**.
  </Step>

  <Step>
    Select the connection you created. Choose the tables and columns you want to query.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Run the query and visualize your data as you want.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# IBM Cognos Analytics
Source: https://docs.cloud.cdata.com/en/Clients/IBMCognos-Client

This page outlines the steps to install and configure the Connect AI connector for IBM Cognos Analytics. After installation, IBM Cognos Analytics will be able to pull data from sources that you have connected to your Connect AI account.

## Prerequisites

Before you can configure and use IBM Cognos Analytics with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

You must also generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

After you have completed the prerequisites above, follow the steps below:

<Steps>
  <Step>
    Download the Connect AI JDBC driver from the Integrations page and install it to the `<cognos>\drivers` directory.
  </Step>

  <Step>
    Open IBM Cognos Analytics and navigate to **Manage** > **Data server connections**.
  </Step>

  <Step>
    Click the icon to add a data server.
  </Step>

  <Step>
    Select **Connect AI**.
  </Step>

  <Step>
    In the connection editor, enter the JDBC URL to the Connect AI server. See the [IBM Cognos Analytics documentation](https://www.ibm.com/en/cognos-analytics) for more information.
  </Step>

  <Step>
    In the username field, enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
  </Step>

  <Step>
    In the password field, enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
  </Step>

  <Step>
    Save the connection definition.
  </Step>

  <Step>
    Click **Test** to confirm that the connection succeeds.
  </Step>
</Steps>

## More Information

For more information about using IBM Cognos Analytics, please refer to the [IBM Cognos Analytics documentation](https://www.ibm.com/en/cognos-analytics). The pages below contain information that pertains to Connect AI:

* [Creating a data server connection](https://www.ibm.com/en/cognos-analytics/12.0.0?topic=servers-creating-data-server-connection)
* [Supported Software Environments](https://www.ibm.com/en/cognos-analytics/12.0.0?topic=icdqa-supported-environments)


# JDBC
Source: https://docs.cloud.cdata.com/en/Clients/JDBC-Client

This page outlines the steps to use the JDBC driver for Connect AI.

## Prerequisites

Before you can configure and use JDBC with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Install the Driver

Download and run the JDBC setup file for your operating system.

* [Windows Download](https://www.cdata.com/download/getfile.aspx?file=free/LFRK-V/setup.exe\&name=CData%20Connect%20JDBC%20Driver\&tag=Download-connect)
* [Linux Download](https://www.cdata.com/download/getfile.aspx?file=free/LFRK-V/setup.zip\&name=CData%20Connect%20JDBC%20Driver\&tag=Download-connect)

## Create a JDBC Data Source

Follow these steps to create a JDBC data source to connect to Connect AI from your Java application:

<Steps>
  <Step>
    Add the driver JAR file to the classpath. The JAR file is located in the `lib` subfolder of the JDBC driver for Connect AI installation directory.

    <Note>
      **Note:** The .lic file must be located in the same folder as the JAR file.
    </Note>
  </Step>

  <Step>
    Some applications automatically populate the driver class. For applications that do not automatically populate it, you must enter it manually. For example:

    ```bash theme={null}
    cdata.jdbc.connect.ConnectDriver
    ```
  </Step>

  <Step>
    Provide the JDBC URL. For example:

    ```bash theme={null}
    jdbc:connect:AuthScheme=OAuth;
    ```

    or

    ```bash theme={null}
    jdbc:cdata:connect:AuthScheme=OAuth;
    ```

    The second format above can be used to ensure you are using the CData driver whenever there is a conflict in your application between drivers using the same URL format. The URL must start with either `jdbc:connect:` or `jdbc:cdata:connect:`, and it must only include the AuthScheme setting as OAuth.
  </Step>
</Steps>

## Connect to Connect AI

There are two ways to connect to Connect AI through the JDBC driver: OAuth authentication and Basic authentication.

To connect to Connect AI using OAuth, set the Auth Scheme in your JDBC connection as OAuth. If the OAuth login page appears in your default web browser, log in to Connect AI to proceed.

If you are unable to use browser-based OAuth authentication to connect to Connect AI, you can use Basic authentication. In this case, set the AuthScheme in your JDBC connection to Basic, and then set the User and Personal Access Token for Connect AI.

## Connect to a Workspace

To connect the JDBC client to a specific [workspace](/en/Workspaces), you specify the workspace name in the **Advanced** tab of the JDBC driver for Connect AI.

<Frame>
  <img alt="JDBC Specify Workspace" />
</Frame>

## Designate a Log File

You can designate a log file for the JDBC driver in the **Advanced** tab of **Connection Properties**. You can also change the verbosity of the log file for greater detail.

<Frame>
  <img alt="JDBC Log File" />
</Frame>

## Learn More

To learn more information about using the JDBC driver for Connect AI, click [here](https://cdn.cdata.com/help/LFM/jdbc/default.htm).


# Jitterbit
Source: https://docs.cloud.cdata.com/en/Clients/Jitterbit-Client

This page outlines the steps to connect Jitterbit to Connect AI using the [OData](/en/API/OData-Dashboard) protocol. This requires the use of workspaces. See the [Workspaces](/en/Workspaces) documentation for more information.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Create a [Workspace](/en/Workspaces). Later, you will use the **OData Service URL** on that page (*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*) with the relevant workspace name to establish the connection.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

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

<Steps>
  <Step>
    Log in to Jitterbit.
  </Step>

  <Step>
    Create a project in Cloud Studio and provide a workspace environment for it.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Connections** and enter OData in the search bar.
  </Step>

  <Step>
    Select the **OData** connector.
  </Step>

  <Step>
    Enter the OData connection properties.

    * **Connection Name**—enter a connection name.
    * **OData Metadata URL**—enter the metadata URL: *[https://cloud.cdata.com/api/odata/\{workspace\\\_name}/\$metadata](https://cloud.cdata.com/api/odata/\{workspace\\_name}/\$metadata)*.
    * **Authentication**—select **Basic Auth**.
    * **User Name**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Test** to test the connection, and then click **Save Changes**.
  </Step>

  <Step>
    Choose the operation you want to perform and drag it to the workflow in your project.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Double-click the query operation to see all the tables and derived views available in your OData endpoint.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Select a table and configure the query.

    You can now transform and integrate your data.
  </Step>
</Steps>


# Looker
Source: https://docs.cloud.cdata.com/en/Clients/Looker-Client

This page outlines the steps to connect Looker to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Looker to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Looker.
  </Step>

  <Step>
    In the navigation pane, select **Admin**. Under the **Database** category, select **Connections**.
  </Step>

  <Step>
    On the **Connections** page, click **Add Connection**.
  </Step>

  <Step>
    Enter the connection settings:

    * **Name**—the name for the connection in models.
    * **Dialect**—select *Microsoft SQL Server 2017+*.
    * **SSH Server**—leave this disabled.
    * **Remote Host:Port**—enter *tds.cdata.com* in the first field and *14333* in the second field.
    * **Database**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
      Leave the rest of the connection settings at their default values unless you need to modify them.
  </Step>

  <Step>
    At the bottom of the page, click **Test These Settings** to ensure that you can connect to Connect AI.
  </Step>

  <Step>
    Click **Add Connection** to create the connection and return to the **Connections** page.
  </Step>
</Steps>

Your connection is now available for use in Looker. To connect to additional data sources from your Connect AI account, repeat the setup steps above, changing the value for **Database** for each data source.


# Looker Studio
Source: https://docs.cloud.cdata.com/en/Clients/LookerStudio-Client

This page outlines the steps to install and configure the Connect AI connector for Looker Studio. After installation, Looker Studio will be able to pull data from sources that you have connected to your Connect AI account.

## Prerequisites

Before you can configure and use Looker Studio with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

<Steps>
  <Step>
    Sign in to [Looker Studio](https://datastudio.google.com/) using your Google account.
  </Step>

  <Step>
    [Click here](https://datastudio.google.com/data?search=CData%20Connect%20AI) to search for the Connect AI connector.\
    Alternatively, from the Looker Studio dashboard, click **+ Create**, then click **Data Source** and search for *Connect AI*.
  </Step>

  <Step>
    Click **Connect AI** to install the connector.
  </Step>

  <Step>
    When prompted, click **Authorize** to allow Looker Studio to use the connector.
  </Step>

  <Step>
    Another **Authorize** button appears to connect to Connect AI. Click this to open a login window.
  </Step>

  <Step>
    Enter your Connect AI login credentials and click **Continue**.
  </Step>

  <Step>
    Close the authorization window when prompted.
  </Step>

  <Step>
    Open the *Connection* drop-down menu, select a connection, and click **Next**.

    <Frame>
      <img alt="Google DS Connection Select" />
    </Frame>
  </Step>

  <Step>
    Use the Table drop-down menu to select the table you want to import.
  </Step>

  <Step>
    (Optional) By default, all data in the table will be imported. If you want to use a custom query for the data instead of retrieving all data, check the **Use custom query** box and enter the parameters in the Custom Query box.

    <Frame>
      <img alt="Google Table" />
    </Frame>
  </Step>

  <Step>
    (Optional) If you want to use the current user's email within a custom query, use the parameter token `@DS_USER_EMAIL` in the query, as follows:

    ```bash theme={null}
    Select * from Sales WHERE sales-rep-email = @DS_USER_EMAIL;
    ```

    Connect AI replaces the parameter with the current user's email address.
  </Step>

  <Step>
    Click **Connect** in the top-right corner of the page. Looker Studio opens an overview of the imported data.

    <Frame>
      <img alt="Google DS Imported" />
    </Frame>
  </Step>
</Steps>

You can now sort, filter, and explore your data and generate reports. For more information about using Looker Studio, please see [Google’s help topics](https://support.google.com/looker-studio/).


# Mendix
Source: https://docs.cloud.cdata.com/en/Clients/Mendix-Client

This page outlines the steps to connect Mendix to Connect AI using the [OData](/en/API/OData-Dashboard) protocol. This requires the use of workspaces. See the [Workspaces](/en/Workspaces) documentation for more information.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Create a [Workspace](/en/Workspaces). Later, you will use the **OData Service URL** on that page (*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*) with the relevant workspace name to establish the connection.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

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

Then, download the OData metadata file according to the steps below.

### Downloading the OData Metadata File

When creating a connection in Mendix, the connection flow requires a Data Source Contract File. Follow these steps to download the OData metadata file for Connect AI using *curl*, a command line tool:

<Steps>
  <Step>
    Open a command-line window for your operating system.

    * On Windows, open the start menu, type *cmd*, and press the enter key to open a command prompt.
    * On macOS and Linux, open a Terminal window.
  </Step>

  <Step>
    To check if curl is installed on your system, type *curl -help* and press the enter key. If it is not installed, install it from [the curl website](https://curl.se/).
  </Step>

  <Step>
    Issue the following curl command, replacing `[user]` with your Connect AI username and `[PAT]` with the PAT you generated above:

    ```bash theme={null}
    curl -u [user]:[PAT] https://cloud.cdata.com/api/odata/service/$metadata -o metadata.xml
    ```
  </Step>

  <Step>
    Locate the metadata.xml file that the curl command created and move it to an accessible location.
  </Step>
</Steps>

## Connect to Connect AI in Mendix

Follow these steps to establish a connection from Mendix to Connect AI:

<Steps>
  <Step>
    Login to Mendix and open the **Data Hub** page.
  </Step>

  <Step>
    In the **Register a Data Source** section, select **OData**.
  </Step>

  <Step>
    Upload the metadata.xml file [from the steps above](#downloading-the-odata-metadata-file) and click **Next**.
  </Step>

  <Step>
    Enter your desired values for **Data Source Name** and **Data Source Version**.
  </Step>

  <Step>
    In the **Data Source Relative Path** field, enter */api/odata/service* and click **Next**.
  </Step>

  <Step>
    On the **Application information** page, click **Register a new application**.
  </Step>

  <Step>
    Enter a name in **Application Name** and select a technical owner (by default, this is the user who is currently logged in).
  </Step>

  <Step>
    Click **Next**. In the **Environment Name** field, enter a desired name (for example, *Connect AI*).
  </Step>

  <Step>
    In the **Environment Location** field, enter *[https://cloud.cdata.com](https://cloud.cdata.com)* and select **Non-Production** for the environment type.
  </Step>

  <Step>
    Click **Done!** to create your connection.
  </Step>
</Steps>

You can now use your connection in Mendix Studio Pro.


# Metabase
Source: https://docs.cloud.cdata.com/en/Clients/Metabase-Client



## Prerequisites

Before you connect Metabase to Connect AI, you must perform the following prerequisites.

In Connect AI:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

To use the Open Source version of Metabase with Connect AI, you need to have a Java Runtime Environment installed on your system. Metabase recommends version 11 of JRE. See the [Metabase Documentation](https://www.metabase.com/latest/installation-and-operation/running-the-metabase-jar-file) for details.

## Download and Install the Metabase JAR File

<Steps>
  <Step>
    [Download the Metabase OSS JAR file](https://www.metabase.com/start/oss/jar).
  </Step>

  <Step>
    Create a new directory and move `metabase.jar` to the new directory.
  </Step>

  <Step>
    In the new directory, run the JAR file:

    ```bash theme={null}
    java -jar metabase.jar
    ```

    Metabase logs its progress in the terminal as it starts up. Wait until you see the message `Metabase Initialization Complete` before you start Metabase.
  </Step>

  <Step>
    Visit `http://localhost:3000/setup` to start Metabase and complete your setup.

    <Frame>
      <img alt="Metabase Client Welcome" />
    </Frame>
  </Step>

  <Step>
    Follow the prompts to set up an admin account.
  </Step>
</Steps>

## Connect to Connect AI

Step 4 of the Metabase setup is adding your data. To connect to Connect AI, do the following:

<Steps>
  <Step>
    Click **SQL Server**.

    <Frame>
      <img alt="Metabase Client Add Data" />
    </Frame>
  </Step>

  <Step>
    Enter the following information:

    * **Display name**—the name of your data for display purposes.
    * **Host**—*tds.cdata.com*
    * **Port**—*14333*
    * **Database name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Database Instance name**—N/A
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="Metabase Client Add Data 2" />
    </Frame>

    Leave the rest of the connection settings at their default values unless you need to modify them. You can change the database details later in Metabase Admin.
  </Step>

  <Step>
    Click **Next**.
  </Step>

  <Step>
    Click **Take me to Metabase**.
  </Step>
</Steps>

## Query Your Data

<Steps>
  <Step>
    In the Home screen, click **New** > **SQL Query**.

    <Frame>
      <img alt="Metabase Client SQL Query" />
    </Frame>
  </Step>

  <Step>
    Select the database you just added.

    <Frame>
      <img alt="Metabase Client Select Database" />
    </Frame>
  </Step>

  <Step>
    Create a SQL query for the data.

    <Frame>
      <img alt="Metabase Client Query" />
    </Frame>
  </Step>

  <Step>
    Click **Run query** to retrieve your data.

    <Frame>
      <img alt="Metabase Client Query Results" />
    </Frame>
  </Step>

  <Step>
    Click **Save** to save your query and add it to your collection.
  </Step>
</Steps>


# MicroStrategy
Source: https://docs.cloud.cdata.com/en/Clients/MicroStrategy-Client

This page outlines the steps to connect MicroStrategy to Connect AI. You can use either Connect AI Virtual SQL Server API or the Connect AI OData endpoint to connect. Note that the Virtual SQL Server API performs better for large datasets, while OData performs well with smaller datasets.

## Prerequisites for Connecting via Virtual SQL Server API

Before you connect via Virtual SQL Server API, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via Virtual SQL Server API

To establish a connection from MicroStrategy to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to MicroStrategy.
  </Step>

  <Step>
    Click **Add External Data** > **Databases**.
  </Step>

  <Step>
    Set the **Import Option** to **Select Tables**.
  </Step>

  <Step>
    In the **Import from Tables** wizard, click "+" to add a new data source.
  </Step>

  <Step>
    Set the connection properties.

    <Frame>
      <img alt="MicroStrategy Client 01" />
    </Frame>

    * **Database**—select **SQL Server**
    * **Version**—select **SQL Server 2017**
    * **Server Name**—enter *tds.cdata.com*
    * **Port Number**—enter *14333*
    * **Database Name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **User**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **Data Source Name**—enter a name for the data source
  </Step>

  <Step>
    Click **Save**.
  </Step>

  <Step>
    Right-click on the new data source and select **Edit Catalog Options**.

    <Frame>
      <img alt="MicroStrategy Client 02" />
    </Frame>
  </Step>

  <Step>
    Edit the SQL column retrieval query to include `TABLE_SCHEMA = '#?Schema_Name?#'` in the WHERE clause. The complete query is below.

    ```bash theme={null}
    SELECT DISTINCT 
     TABLE_SCHEMA NAME_SPACE, 
     TABLE_NAME TAB_NAME, 
     COLUMN_NAME COL_NAME, 
     (CASE 
         WHEN 
         (DATA_TYPE LIKE '%char' AND (CHARACTER_SET_NAME='utf8' OR CHARACTER_SET_NAME='usc2')) 
         THEN 
         CONCAT('a',DATA_TYPE) 
         ELSE 
         DATA_TYPE 
     END) DATA_TYPE, 
     CHARACTER_MAXIMUM_LENGTH DATA_LEN, 
     NUMERIC_PRECISION DATA_PREC, 
     NUMERIC_SCALE DATA_SCALE 
     FROM 
     INFORMATION_SCHEMA.COLUMNS 
     WHERE 
     TABLE_NAME 
     IN 
     (#TABLE_LIST#) AND TABLE_SCHEMA='#?Schema_Name?#' 
     ORDER BY 
     1,2,3
    ```
  </Step>

  <Step>
    Click **Apply** > **OK**.
  </Step>

  <Step>
    Select the new data source and select the Namespace that corresponds to your virtual database (like SharePoint1).

    <Frame>
      <img alt="MicroStrategy Client 03" />
    </Frame>
  </Step>

  <Step>
    Drag tables into the pane to insert them.
  </Step>

  <Step>
    Click **Finish** and choose the option to connect live.
  </Step>

  <Step>
    Click **Create Dossier**.

    <Frame>
      <img alt="MicroStrategy Client 04" />
    </Frame>
  </Step>

  <Step>
    You can now create a new visualization of your connected data.
  </Step>
</Steps>

## Prerequisites for Connecting via OData Endpoint

Before you connect to Connect AI via the OData endpoint, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Create a [Workspace](/en/Workspaces). Later, you will use the **OData Service URL** on that page (*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*) with the relevant workspace name to establish the connection.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via OData Endpoint

To connect to Connect AI using the OData protocol, follow these steps.

<Steps>
  <Step>
    Log in to MicroStrategy.
  </Step>

  <Step>
    Click **Add Data**.
  </Step>

  <Step>
    In **Data Sources**, select **Data from URL**.

    <Frame>
      <img alt="MicroStrategy Client Data URL" />
    </Frame>
  </Step>

  <Step>
    In the **Data from URL** dialog, set the connection properties.

    * In the text box, paste the **OData URL** copied from the **Endpoints** dialog of your workspace. The URL is in the following format: *[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*.
    * Select **OData** from the drop-down list.

    <Frame>
      <img alt="MicroStrategy Client OData" />
    </Frame>
  </Step>

  <Step>
    Click **Add** to add the new connector.
  </Step>

  <Step>
    Click **Prepare Data** to see a preview of your data.

    <Frame>
      <img alt="MicroStrategy Client Preview" />
    </Frame>
  </Step>

  <Step>
    Click **Finish** when you are done adding your connector(s).
  </Step>

  <Step>
    You can now create a new visualization of your connected data.

    <Frame>
      <img alt="MicroStrategy Client Visualization" />
    </Frame>
  </Step>
</Steps>


# Microsoft Fabric
Source: https://docs.cloud.cdata.com/en/Clients/MicrosoftFabric-Client

You can connect Microsoft Fabric to Connect AI with the Connect AI plugin.

## Prerequisites

Before you connect, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Connect to Connect AI

To establish a connection from Microsoft Fabric to Connect AI, follow these steps.

<Steps>
  <Step>
    Log in to Microsoft Fabric.
  </Step>

  <Step>
    In Microsoft Fabric, select a workspace in which to create the flow, or create a new workspace.
  </Step>

  <Step>
    Click **New item** and then click **Dataflow Gen2**.

    <Frame>
      <img alt="Fabric Client New Item" />
    </Frame>
  </Step>

  <Step>
    Once inside the data flow, click **Get Data**. Enter *Connect AI* in the search bar and select the **Connect AI** plugin.

    <Frame>
      <img alt="Fabric Client Choose Data" />
    </Frame>
  </Step>

  <Step>
    In the **Get data** dialog, enter the following credentials:

    * **Connection**—select **Create new connection**.
    * **Connection name**—create a user-defined connection name.
    * **Data gateway**—select **(none)**.
    * **Authentication kind**—select **CData Connect account**.

    <Frame>
      <img alt="Fabric Client Sign In" />
    </Frame>
  </Step>

  <Step>
    Click **Sign in**. You are redirected to our authentication page via OAuth, establishing a connection to Connect AI.
  </Step>

  <Step>
    Click **Next**. All your connections, derived views, and workspaces are now visible.

    <Frame>
      <img alt="Fabric Client Connections" />
    </Frame>
  </Step>

  <Step>
    Select a table in your connection/schema hierarchy to load the desired table.

    <Frame>
      <img alt="Fabric Client Load Table" />
    </Frame>
  </Step>

  <Step>
    Click **Create** to launch the **Power Query** page.

    <Frame>
      <img alt="Fabric Client Power Query" />
    </Frame>
  </Step>

  <Step>
    To replicate your data to a destination, click **+** next to **Data destination**. A **Connect to data destination** dialog appears. In this example, we used SQL Server as a destination. Enter the destination settings and click **Next**.

    <Frame>
      <img alt="Fabric Client Data Destination" />
    </Frame>
  </Step>

  <Step>
    Select a destination target. You can overwrite an existing table or create a new destination table. Click **Next**.

    <Frame>
      <img alt="Fabric Client Destination Target" />
    </Frame>
  </Step>

  <Step>
    Map the data types for your destinations. Click **Save settings**.

    <Frame>
      <img alt="Fabric Client Destination Settings" />
    </Frame>
  </Step>

  <Step>
    When you run/refresh the data flow, your table is copied to the selected destination. You can also modify the content in the Power Query editor.

    <Frame>
      <img alt="Fabric Client Query Editor" />
    </Frame>
  </Step>
</Steps>


# Microsoft Foundry
Source: https://docs.cloud.cdata.com/en/Clients/MicrosoftFoundry-Client

You can connect Microsoft Foundry to the Connect AI MCP Server to discover and use external tools and data sources.

## Prerequisites

Before you can configure and use Microsoft Foundry with Connect AI, you must do the following:

* Connect a data source to your Connect AI account if you have not done so already. See [Sources](/en/Sources) for more information.

* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

* Base64 encode your Connect AI username.

## Connect Microsoft Foundry to the Connect AI MCP

<Steps>
  <Step>
    Create a project in Microsoft Foundry.
  </Step>

  <Step>
    Click **Create Agent**.

    <Frame>
      <img alt="Foundry Agent List" />
    </Frame>
  </Step>

  <Step>
    Provide a name for your agent, and then click **Create**.

    <Frame>
      <img alt="Create New Foundry Agent" />
    </Frame>
  </Step>

  <Step>
    After naming your agent, click **Save**. Add instructions (optional). Under **Tools**, click **Add**.

    <Frame>
      <img alt="Foundry Add Tools" />
    </Frame>
  </Step>

  <Step>
    In the **Select a tool** dialog, click the **Custom** tab, and then click **Model Context Protocol**.

    <Frame>
      <img alt="Select Custom Tool" />
    </Frame>
  </Step>

  <Step>
    In the **Add Model Context Protocol** dialog, enter the following:

    * **Name**–the name of your MCP server, for example, *ConnectAIMCPServer*.
    * **Remote MCP Server endpoint**–*[https://mcp.cloud.cdata.com/mcp](https://mcp.cloud.cdata.com/mcp)*.
    * **Authentication**–select **Key-based**.
    * **Credential**–enter *Basic(YourConnectAIUsernameConvertedToBase64:YourPersonalAccessToken)*, for example, *Basic(anNtaXRoQGV4YW1wbGUuY29t:a1b2c3d4e5f6g7h8i9j0k1l2)*.

    <Frame>
      <img alt="Add MCP Tool" />
    </Frame>
  </Step>

  <Step>
    Click **Connect**. You should see the MCP server listed under **Tools**.
  </Step>

  <Step>
    Click **Save** again to save your agent.
  </Step>

  <Step>
    You can confirm your connection by clicking the **YAML** tab. You should see the following:

    <Frame>
      <img alt="Foundry View Yaml" />
    </Frame>
  </Step>

  <Step>
    Click the **Chat** tab and ask the agent a question about your data. The agent shows the tools used to arrive at an answer.

    <Frame>
      <img alt="Foundry Enter Prompt" />
    </Frame>
  </Step>
</Steps>


# Microsoft Power Apps
Source: https://docs.cloud.cdata.com/en/Clients/MicrosoftPowerApps-Client

You can connect Microsoft Power Apps to Connect AI via the OpenAPI specification or via the Virtual SQL Server API.

## Prerequisites for Connecting via OpenAPI

Before you connect via OpenAPI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* [Add a workspace](/en/Workspaces#add-a-workspace) to Workspaces.
* [Add assets](/en/Workspaces#workspace-assets) to your workspace.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect via OpenAPI

To establish a connection from Microsoft Power Apps to Connect AI via OpenAPI, follow these steps.

<Steps>
  <Step>
    In **Workspaces** in Connect AI, select a workspace and download the OpenAPI specification for the workspace. See [OpenAPI](/en/API/OpenAPI) for more information.

    <Note>
      You must use OpenAPI version 2.0 and select **Convert array types to strings**.
    </Note>

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Log in to Microsoft Power Apps.
  </Step>

  <Step>
    Select **Custom connectors** to create a custom connector (you may need to click **Discover all** to find **Custom connectors**).
  </Step>

  <Step>
    Select **New custom connector** > **Import an OpenAPI file**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter a **Connector name** and import the OpenAPI specification file you downloaded.
  </Step>

  <Step>
    In the **1. General** step, enter general information about the connector, including a description. **Host** and **Base URL** are required, but are already filled in.
  </Step>

  <Step>
    In the **2. Security** step, select an **Authentication type** of **Basic authentication**. Users have to provide a user name and password before using this API. Enter the parameter labels that users will see.

    <Note>
      When you use the custom connector, the user name is the Connect AI user name, and the password is the PAT created in the prerequisites.
    </Note>
  </Step>

  <Step>
    The **3. Definition** step of the connector defines all the actions of the connector that are contained in the OpenAPI specification file. The actions include all the functions you need for the table, including list, get, create, update, and delete records.
    In the **3. Definition** step, you can edit the **Actions**, **References**, and **Policies** imported from the OpenAPI specification.

    * **Actions**—each action in the custom connector has **General** information, as well as the **Request**, **Response**, and **Validation** of the response.
      For example, the following request is a GET request to list drives.

    <Frame>
      <img alt="" />
    </Frame>

    The request includes query parameters that are appended to the URL, such as `$top`, `$filter`, and `$orderby`. You can edit and delete the query parameters here. The parameters are based on the OData protocol.
    See [API Operations](/en/API/OpenAPI#api-operations) for a complete reference.
    The **Test** step of creating a custom connector is where you can test out the query parameters.
    Similarly, there is a POST request to create a new record. The request contains all the fields for the record. You can edit these fields in the definition.

    * **References**—reusable parameters that are used by both actions and triggers. Each reference has a **Definition** and **Validation**.
    * **Policies**—used to change the behavior of actions through configuration.
  </Step>

  <Step>
    Save the custom connector.
  </Step>

  <Step>
    In the **6. Test** step, you can test the behavior of each operation defined in the OpenAPI specification by applying query parameters.
    For example, you can test the `$top` and `$orderby` query parameters by returning the top 100 records, ordered by `name`.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    You can now build apps with your custom connector.
  </Step>
</Steps>

## Prerequisites for Connecting via Virtual SQL Server API

Before you connect via the Virtual SQL Server API, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* If you want to connect to a Connect AI workspace, [add a workspace](/en/Workspaces#add-a-workspace) to Workspaces and [add assets](/en/Workspaces#workspace-assets) to your workspace.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect via the Virtual SQL Server API

To establish a connection from Microsoft Power Apps to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Microsoft Power Apps.
  </Step>

  <Step>
    In the navigation menu, open **More** > **Connections**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **New connection** to open the list of available connections.
  </Step>

  <Step>
    Select **SQL Server**. In the dialog that appears, select **SQL Server Authentication**.
  </Step>

  <Step>
    Enter the connection settings.

    * **SQL server name**—enter the Virtual SQL Server endpoint and port separated by a comma: *tds.cdata.com*,*14333*
    * **SQL database name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*). To connect to a workspace, set the **SQL database name** to the name of your workspace (for example, *MyWorkspace*).
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*. To connect to a workspace, set the **Username** to `[CData_username]@[workspace_name]` (for example, *[test@cdata.com](mailto:test@cdata.com)@MyWorkspace*).
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * Leave the **Choose a gateway** field blank.
      *Connecting to a source*:

    <Frame>
      <img alt="" />
    </Frame>

    *Connecting to a workspace*:

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Create** to establish the connection.
  </Step>
</Steps>

Your connection now appears in your connection list. You can add more data sources from your Connect AI account by repeating this process and entering a different **SQL database name**.

<Note>
  You can preview your virtual table in Microsoft Power Apps only if you have an INTEGER column primary key in your table. Refer to the [Microsoft Power Apps documentation](https://learn.microsoft.com/en-us/power-apps/maker/data-platform/limits-tshoot-virtual-tables?tabs=sql) for details.
</Note>

## Learn More

For more information about SQL Server connections in Microsoft Power Apps, please see [Microsoft’s support article](https://docs.microsoft.com/en-us/powerapps/maker/canvas-apps/connections/connection-azure-sqldatabase).


# Microsoft Power Automate
Source: https://docs.cloud.cdata.com/en/Clients/MicrosoftPowerAutomate-Client

You can connect Microsoft Power Automate to Connect AI via the OpenAPI specification or via Virtual SQL Server API.

## Prerequisites for Connecting via OpenAPI

Before you connect via OpenAPI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* [Add a workspace](/en/Workspaces#add-a-workspace) to Workspaces.
* [Add assets](/en/Workspaces#workspace-assets) to your workspace.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect via OpenAPI

To establish a connection from Microsoft Power Automate to Connect AI via OpenAPI, follow these steps.

<Steps>
  <Step>
    In **Workspaces** in Connect AI, select a workspace and download the OpenAPI specification for the workspace. See [OpenAPI](/en/API/OpenAPI) for more information.

    <Note>
      You must use OpenAPI version 2.0 and select **Convert array types to strings**.
    </Note>

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Log in to Microsoft Power Automate.
  </Step>

  <Step>
    Select **Custom connectors** to create a custom connector (you may need to click **More** > **Discover all** to find **Custom connectors**).
  </Step>

  <Step>
    Select **New custom connector** > **Import an OpenAPI file**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter a **Connector name** and import the OpenAPI specification file you downloaded.
  </Step>

  <Step>
    In the **1. General** step, enter general information about the connector, including a description. **Host** and **Base URL** are required, but are already filled in.
  </Step>

  <Step>
    In the **2. Security** step, select an **Authentication type** of **Basic authentication**. Users have to provide a user name and password before using this API. Enter the parameter labels that users will see.

    <Note>
      When you use the custom connector, the user name is the Connect AI user name, and the password is the PAT created in the prerequisites.
    </Note>
  </Step>

  <Step>
    The **3. Definition** step of the connector defines all the actions of the connector that are contained in the OpenAPI specification file. The actions include all the functions you need for the table, including list, get, create, update, and delete records.
    In the **3. Definition** step, you can edit the **Actions**, **References**, and **Policies** imported from the OpenAPI specification.

    * **Actions**—each action in the custom connector has **General** information, as well as the **Request**, **Response**, and **Validation** of the response.
      For example, the following request is a GET request to list drives.

    <Frame>
      <img alt="" />
    </Frame>

    The request includes query parameters that are appended to the URL, such as `$top`, `$filter`, and `$orderby`. You can edit and delete the query parameters here. The parameters are based on the OData protocol.
    See [API Operations](/en/API/OpenAPI#api-operations) for a complete reference.
    The **Test** step of creating a custom connector is where you can test out the query parameters.
    Similarly, there is a POST request to create a new record. The request contains all the fields for the record. You can edit these fields in the definition.

    * **References**—reusable parameters that are used by both actions and triggers. Each reference has a **Definition** and **Validation**.
    * **Policies**—used to change the behavior of actions through configuration.
  </Step>

  <Step>
    Click **Create connector** to save the custom connector.
  </Step>

  <Step>
    In the **6. Test** step, you can test the behavior of each operation defined in the OpenAPI specification by applying query parameters.
    For example, you can test the `$top` and `$orderby` query parameters by returning the top 100 records, ordered by `name`.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Once the custom connector is created, click the **+** sign to create a connection with the custom connector.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Provide your Connect AI user name and password. The password is the PAT created in the prerequisites.
  </Step>

  <Step>
    Go to **My flows**. Select **New flow** > **Instant cloud flow**. The **Build an instant cloud flow** dialog appears.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter a flow name and trigger, and click **Create**.
  </Step>

  <Step>
    Click **+** to add an action.
  </Step>

  <Step>
    Select **Custom** from the **Runtime** drop-down list and click the custom connector you created.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Choose the request you want to send. Once the flow is successfully completed, you can test the outputs for your flow.
  </Step>
</Steps>

## Prerequisites for Connecting via Virtual SQL Server API

Before you connect via the Virtual SQL Server API, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* If you want to connect to a Connect AI workspace, [add a workspace](/en/Workspaces#add-a-workspace) to Workspaces and [add assets](/en/Workspaces#workspace-assets) to your workspace.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect via the Virtual SQL Server API

<Steps>
  <Step>
    Log in to Microsoft Power Automate.
  </Step>

  <Step>
    In the navigation menu, open **More** > **Connections**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **New connection** to open the list of available connections.
  </Step>

  <Step>
    Select **SQL Server**. In the dialog that appears, select **SQL Server Authentication**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter the connection settings.

    * **SQL server name**—enter the Virtual SQL Server endpoint and port separated by a comma: *tds.cdata.com*,*14333*
    * **SQL database name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*). To connect to a workspace, set the **SQL database name** to the name of your workspace (for example, *MyWorkspace*).
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*. To connect to a workspace, set the **Username** to `[CData_username]@[workspace_name]` (for example, *[test@cdata.com](mailto:test@cdata.com)@MyWorkspace*).
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * Leave the **Choose a gateway** field blank.
      *Connecting to a source*:

    <Frame>
      <img alt="" />
    </Frame>

    *Connecting to a workspace*:

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Create** to establish the connection.
  </Step>
</Steps>

Your connection now appears in your connection list. You can add more data sources from your Connect AI account by repeating this process and entering a different **SQL database name**.

## Learn More

For more information about SQL Server connections in Microsoft Power Automate, please see [Microsoft’s support article](https://learn.microsoft.com/en-us/connectors/sql/).


# Mistral Le Chat
Source: https://docs.cloud.cdata.com/en/Clients/Mistral-Client

The Connect AI Remote MCP Service enables Mistral Le Chat to securely read and take action on your data in real time.

This page outlines the steps to configure Mistral Le Chat to use the Connect AI Remote MCP Service. You can then use natural language to query your data in real time.

## Prerequisites

Before you can configure and use Mistral Le Chat with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Configure the Connect AI MCP Server

<Steps>
  <Step>
    Log in to Mistral Le Chat.
  </Step>

  <Step>
    In the navigation menu, select **Intelligence**, and then select **Connectors**. Click **+Add Connector**.

    <Frame>
      <img alt="Mistral Connectors" />
    </Frame>
  </Step>

  <Step>
    In the dialog, select **Custom MCP Connector** and enter the following details:

    * **Connector Name**–enter a name for the connector, such as *CData\_Remote\_MCP*.
    * **Connector Server**–enter the URL for the MCP server: *[https://mcp.cloud.cdata.com/mcp](https://mcp.cloud.cdata.com/mcp)*.
    * **Description**–enter a description for the connector.
    * **Authentication Method**–select **API Token Authentication**.
    * **Header name**–enter *Authorization*.
    * **Header type**–select **Basic**.
    * **Header value**-enter *EmailAddress:PAT*, replacing *Email* with your Connect AI username and *PAT* with the PAT obtained in the prerequisites.

    <Frame>
      <img alt="Mistral MCP" />
    </Frame>
  </Step>

  <Step>
    Click **Create** to create the new connector.
  </Step>

  <Step>
    Scroll down to the bottom of **My Connectors** to view the connector you created. This step ensures that Mistral Le Chat can securely route queries through the CData Remote MCP Server to your data.

    <Frame>
      <img alt="Mistral New Connector" />
    </Frame>
  </Step>

  <Step>
    In **Chat**, click the enable tools icon and ensure that your new connector is selected.

    <Frame>
      <img alt="Mistral Tools" />
    </Frame>
  </Step>

  <Step>
    You can run a discovery query such as *Get catalogs* or *Get tables* to see the available data sources and schemas connected through Connect AI.

    <Frame>
      <img alt="Mistral Catalogs" />
    </Frame>
  </Step>

  <Step>
    You can now begin using natural language to query your data. Ask a question like "Compare the win rate of opportunities across different industries."

    <Frame>
      <img alt="Mistral Prompt" />
    </Frame>
  </Step>
</Steps>


# Mode
Source: https://docs.cloud.cdata.com/en/Clients/Mode-Client

This page outlines the steps to connect Mode to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Mode to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Mode.
  </Step>

  <Step>
    On the **Discover** page of Mode, click **Connect a Database**.

    <Frame>
      <img alt="Mode Client Connect Database" />
    </Frame>
  </Step>

  <Step>
    On the next screen, select **Microsoft SQL Server**.

    <Frame>
      <img alt="Mode Client SQL Server" />
    </Frame>
  </Step>

  <Step>
    Enter the following Microsoft SQL Server settings.

    * **Display name**—enter the name of your connection for display purposes.
    * **Host**—*tds.cdata.com*
    * **Port**—*14333*
    * **Database name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
      Leave the rest of the connections settings at their default values unless you need to modify them.

    <Frame>
      <img alt="Mode Client Connection Credentials" />
    </Frame>
  </Step>

  <Step>
    Click **Connect**. If the connection succeeds, a success message appears. Your connection is now available for use in Mode.
  </Step>

  <Step>
    Repeat the steps above to connect to additional Connect AI sources, changing the **Database name** for each one.
  </Step>
</Steps>

You can now create a Mode visualization with the Connect AI data. Follow the steps below.

<Steps>
  <Step>
    After your connection succeeds, click **New Report**. The SQL query text editor appears.

    <Frame>
      <img alt="Mode Client Create Report" />
    </Frame>
  </Step>

  <Step>
    Enter a SQL query for your data, such as:
  </Step>
</Steps>

```sql theme={null}
SELECT * FROM [Sharepoint].[MyCustomList];
```

<Steps>
  <Step>
    Click **Run** to run the query. The data appears below.
  </Step>

  <Step>
    Click **+New chart** to create visualizations from the data.

    <Frame>
      <img alt="Mode Client Create Chart" />
    </Frame>
  </Step>
</Steps>


# MuleSoft
Source: https://docs.cloud.cdata.com/en/Clients/Mulesoft-Client

This page outlines the steps to install and configure the Connect AI connector for MuleSoft. After installation, MuleSoft can pull data from sources that you have connected to your Connect AI account.

## Prerequisites

Before you can configure and use MuleSoft with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

You must also generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from MuleSoft to Connect AI through the JDBC driver, follow these steps.

<Steps>
  <Step>
    Download and install the Connect AI JDBC driver.

    a. Open the **Integrations** page of Connect AI.

    b. In the **Dev Tools** section, click **JDBC**.

    c. Download and run the setup file.

    d. When the installation is complete, the JAR file can be found in the installation directory.
  </Step>

  <Step>
    Log in to MuleSoft Anypoint Studio or launch the desktop application.
  </Step>

  <Step>
    Create a new MuleSoft project.

    <Frame>
      <img alt="" />
    </Frame>

    The new project appears in a project folder.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the **Mule Palette** on the right, drag a HTTP Listener to the **Message Flow** area.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click the **HTTP Listener** to configure it.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click the **+** sign to the right of **Connector configuration**. The **HTTP Listener config** dialog appears.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Configure the HTTP Listener, providing a **Port** on which to query your data, and click **OK**.
  </Step>

  <Step>
    Provide a path on which to perform the actions. The HTTP Listener is now configured.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the **Mule Palette** on the right, type `database` in the search bar.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Drag the database operation you want to perform to the **Message Flow** area. For this example, we choose **Select**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click the **Configure** button to configure the JDBC driver. Select **Use local file** from the drop-down list.
  </Step>

  <Step>
    Locate the Connect AI JAR file from the JDBC driver installation and click **OK**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Provide the following information:

    * **URL**–the URL for the connection, for example: `jdbc:connect:Authscheme=Basic;user=username;password=password`.

    <Note>
      the password is the PAT created in the prerequisites.
    </Note>

    * **Driver class name**–`cdata.jdbc.connect.ConnectDriver`

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Test Connection**.
  </Step>

  <Step>
    If the connection is successful, provide the **SQL Query Text** in the editor. You can see the metadata of the table on the right side in the **Output** tab.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the **Mule Palette**, drag **Transform Message** to the **Message Flow** area.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Transform Message** to configure it. Change the **Output** as follows:

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Save your project and run it. In the console, MuleSoft starts initializing the dependencies.
  </Step>

  <Step>
    Once you see the message, `Message source 'listener' on flow your_project_name successfully started`, you can start querying your data at the endpoint you provided.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# n8n
Source: https://docs.cloud.cdata.com/en/Clients/N8N-Client

The Connect AI Remote MCP Service enables n8n to securely read and take action on your data in real time.

This page outlines the steps to install and configure the Connect AI connector for n8n. After installation, n8n can pull data from sources that you have connected to your Connect AI account.

## Prerequisites

Before you can configure and use n8n with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

Follow these steps to connect to Connect AI in n8n:

<Steps>
  <Step>
    Sign in to [n8n.io](https://n8n.io/) or create a new account.
  </Step>

  <Step>
    Create a workflow in n8n that uses the MCP client tool. The example below acts as a chatbot. OpenAI was used as the Chat Model, and Simple Memory was used as the Memory.

    <Frame>
      <img alt="N8N Workflow" />
    </Frame>
  </Step>

  <Step>
    Configure the MCP Client node in the Workflow:

    * **Endpoint**–enter *[https://mcp.cloud.cdata.com/mcp](https://mcp.cloud.cdata.com/mcp)*.
    * **Server Transport**–select **HTTP Streamable**.
    * **Authentication**–select **Header Auth**.

    <Frame>
      <img alt="N8N MCP" />
    </Frame>
  </Step>

  <Step>
    Edit the **Header Auth account**. In the **Connection** tab, set the following properties to use Basic Authentication:

    * **Name**–enter *Authorization*.
    * **Value**–enter the value in the form *Basic EMAIL:PAT*, replacing EMAIL and PAT with your Connect AI email address and the PAT created in the prerequisites. For example: *Basic [email@cdata.com](mailto:email@cdata.com):Uu90pt5vEO…*.

    <Frame>
      <img alt="N8N Connection" />
    </Frame>
  </Step>

  <Step>
    (Optional) Give the AI Agent context. This establishes the AI Agent's role and provides context for the conversation through the System Message parameter in the AI Agent node. By providing a system message that explicitly informs the agent about its role as an MCP Server expert and lists the available tools, you can enhance the agent's understanding and response accuracy.
    The following is an example System Message:

    ```text theme={null}
    You are an expert at using the MCP Client tool connected which is the Connect AI MCP Server. Always search thoroughly and use the most relevant MCP Client tool for each query. Below are the available tools and a description of each:
    queryData: Execute SQL queries against connected data sources and retrieve results. When you use the queryData tool, ensure you use the following format for the table name: catalog.schema.tableName
    execData: Execute stored procedures against connected data sources
    getCatalogs: Retrieve a list of available connections from Connect AI. The connection names should be used as catalog names in other tools and in any queries to Connect AI. Use the \`getSchemas\` tool to get a list of available schemas for a specific catalog.
    getColumns: Retrieve a list of available database columns from Connect AI for a specific catalog, schema, and table.
    getExportedKeys: Retrieve a list of foreign key relationships from Connect AI for a specific catalog, schema, and table.
    getImportedKeys: Retrieve a list of foreign key relationships from Connect AI for a specific catalog, schema, and table.
    getIndexes: Retrieve a list of indexes from Connect AI for a specific catalog, schema, and table.
    getPrimaryKeys: Retrieve a list of primary keys from Connect AI for a specific catalog, schema, and table.
    getProcedures: Retrieve a list of stored procedures from Connect AI for a specific catalog and schema
    getProcedureParameters: Retrieve a list of stored procedure parameters from Connect AI for a specific catalog, schema, and procedure.
    getSchemas: Retrieve a list of available database schemas from Connect AI for a specific catalog. Use the \`getTables\` tool to get a list of available tables for a specific catalog and schema.
    getTables: Retrieve a list of available database tables from Connect AI for a specific catalog and schema. Use the \`getColumns\` tool to get a list of available columns for a specific table.
    ```
  </Step>

  <Step>
    Now that you created the Workflow in n8n and connected the MCP Client, you can interact with your data. The MCP Client node allows you to send queries and receive responses from the data source in real time.
  </Step>

  <Step>
    Open the Workflow in n8n and execute it to start interacting with your data. You can ask questions, retrieve data, and perform actions on your data using the MCP Client node:

    <Frame>
      <img alt="N8N Execute" />
    </Frame>
  </Step>
</Steps>


# Nintex
Source: https://docs.cloud.cdata.com/en/Clients/Nintex-Client

This page outlines the steps to connect Nintex to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Nintex to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Nintex Workflow Cloud.
  </Step>

  <Step>
    In the Connections tab, click **Add New**.
  </Step>

  <Step>
    Select **Microsoft SQL Server** as the **Connector** type.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Connect**. This opens the SQL Server connection wizard.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the wizard, enter a **Connection Name**, such as *Connect AI Connection*.
  </Step>

  <Step>
    Enter your Connect AI **Username**.
  </Step>

  <Step>
    Enter your Connect AI PAT in the **Password** field.
  </Step>

  <Step>
    Enter *tds.cdata.com:14333* in **Database Host**.
  </Step>

  <Step>
    Enter the name of the **Database** to connect to.
  </Step>

  <Step>
    Click **Connect**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Configure the Connect AI **Owner** and **User** permissions and click **Save Permissions** to complete the connection.
  </Step>
</Steps>


# No-Code Tools
Source: https://docs.cloud.cdata.com/en/Clients/NoCodeTools

Below is a list of No-Code/Low-Code tools that connect to Connect AI:

* [AppSheet](/en/Clients/AppSheet-Client)
* [AWS App Studio](/en/Clients/AWSAppStudio-Client)
* [Azure Logic Apps](/en/Clients/AzureLogicApps-Client)
* [Bubble](/en/Clients/Bubble-Client)
* [Filemaker Pro](/en/Clients/Claris-Client)
* [Mendix](/en/Clients/Mendix-Client)
* [Microsoft Power Apps](/en/Clients/MicrosoftPowerApps-Client)
* [Microsoft PowerAutomate](/en/Clients/MicrosoftPowerAutomate-Client)
* [Nintex](/en/Clients/Nintex-Client)
* [Outsystems](/en/Clients/Outsystems-Client)
* [Retool](/en/Clients/Retool-Client)
* [Salesforce External Services](/en/Clients/SalesforceExternal-Client)
* [Salesforce Lightning Connect](/en/Clients/SFLC-Client)
* [Workato](/en/Clients/Workato-Client)
* [Zapier](/en/Clients/Zapier-Client)


# Node.js
Source: https://docs.cloud.cdata.com/en/Clients/Nodejs-Client

This page outlines the steps to connect Node.js to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

In order to connect from Node.js to Connect AI via the SQL Server interface, you need the following information:

* **Server**—*tds.cdata.com*
* **Port**—*14333*
* **Database name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
* **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
* **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

Use the following code to connect to your database with Node.js, and change the following:

* Update `user` with your Connect AI username.
* Update `password` with the PAT you generated in the prerequisites.
* Update `database` with the name of the data source you created in the prerequisites.
* Replace the `query` with your database query.

```javascript expandable theme={null}
var sql = require('mssql')
var config = {
   server: 'tds.cdata.com',
   port: 14333,
   user: 'user@mydomain.com', //your Connect AI username
   password: 'CONNECT_USER_PAT', //your Connect AI PAT  
   options: {
      encrypt: true,
      database: 'SAPHANA1' //the name of your database connection
   }
}
 
sql.connect(config, err => {
   if(err){
      throw err ;
   }
   new sql.Request().query('SELECT * FROM Buckets', (err, result) => { //your query
      console.dir(result)
   })
 
});
 
sql.on('error', err => {
   console.log("SQL Error: " ,err);
})
```


# ODBC
Source: https://docs.cloud.cdata.com/en/Clients/ODBC-Client

This page outlines the steps to use the ODBC Driver for Connect AI.

## Prerequisites

Before you can configure and use ODBC with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Install the Driver

<Steps>
  <Step>
    Download and run the ODBC setup file for your operating system.

    * [Windows Download](https://www.cdata.com/download/getfile.aspx?file=free/LFDK-A/setup.exe\&name=CData%20Connect%20ODBC%20Driver\&tag=Download-connect)
    * [Linux Download (64-bit.deb)](https://www.cdata.com/download/getfile.aspx?file=free/LFDK-U/setup.x86_64.deb\&name=CData%20Connect%20ODBC%20Driver%20\(Unix\)\&tag=Download-connect)
    * [Linux Download (64-bit.rpm)](https://www.cdata.com/download/getfile.aspx?file=free/LFDK-U/setup.x86_64.rpm\&name=CData%20Connect%20ODBC%20Driver%20\(Unix\)\&tag=Download-connect)
  </Step>

  <Step>
    After installation, follow the steps for your platform below.
  </Step>
</Steps>

## Create a DSN

The following guides show how to use the standard tools to configure data source names (DSN). You will need to configure the DSN to use the driver.

### Windows

Follow these steps to edit the DSN configuration using the Microsoft ODBC Data Source Administrator:

<Steps>
  <Step>
    Open the Start menu and enter *ODBC Data Sources* in the Search box.
  </Step>

  <Step>
    Choose the version of the ODBC Administrator that corresponds to your application (32-bit or 64-bit).
  </Step>

  <Step>
    Click the **System DSN** tab.
  </Step>

  <Step>
    Select **Connect Sys** and click **Configure**.
  </Step>

  <Step>
    For the **Auth Scheme**, select **OAuth**.
  </Step>

  <Step>
    In the **Misc** section, enter the connection name of the data source you want to access in the **Default Catalog** field (e.g., Salesforce1).
  </Step>

  <Step>
    Click **Test Connection** to open the Connect AI sign-in window in your web browser.
  </Step>

  <Step>
    If you are not already signed in, sign in to your Connect AI account.
  </Step>

  <Step>
    When the **OAuth Authorization Successful** message appears, close the web browser and return to the ODBC Administrator.
  </Step>

  <Step>
    Click **OK** on the success message, **OK** in the DSN Configuration window, then **OK** in the ODBC Data Source Administrator window.
  </Step>
</Steps>

<Note>
  **Note:** For .NET Framework 4.0, the driver distributes Microsoft Visual C++ 2017 Redistributable. For .NET Framework 3.5, the driver distributes Microsoft Visual C++ 2008 Redistributable.
</Note>

### macOS

<Note>
  **Note:** The ODBC Driver for Connect AI requires macOS Sierra (10.12) or above.
</Note>

On macOS, the ODBC Driver for Connect AI is pre-configured for use with the iODBC driver manager. You can find the latest version of iODBC on the [iODBC site](http://www.iodbc.org/).

Follow these steps to configure the driver:

<Steps>
  <Step>
    Install iODBC and ODBC Driver for the Connect AI.
  </Step>

  <Step>
    Launch the iODBC Data Source Administrator.

    * Under most circumstances, the driver should automatically appear in the **System DSN** tab of the iODBC Data Source Administrator. If it does, continue to [Logging In](#logging-in).
    * If the driver does not appear automatically, follow the steps under [Manually Add the Driver](#manually-add-the-driver).
  </Step>
</Steps>

#### Logging In

Follow the steps below to connect the driver to your Connect AI account:

<Steps>
  <Step>
    In the iODBC Data Source Administrator, click on the driver entry on the **User DSN** or **System DSN** tab to select it.
  </Step>

  <Step>
    Click **Test**.
  </Step>

  <Step>
    A login prompt appears. Leave the fields blank and click **OK**.
  </Step>

  <Step>
    The Connect AI OAuth login page opens in your default web browser. If you are not already logged in, enter your credentials and sign in.
  </Step>

  <Step>
    When the OAuth success page appears, close the window and return to iODBC.
  </Step>

  <Step>
    Click **OK** on the success message, and click **OK** to close the iODBC Data Source Administrator.
  </Step>
</Steps>

You can now use the configured connection in any tools or applications that support ODBC connectivity.

#### Manually Add the Driver

If the ODBC Driver for Connect AI does not automatically appear in the iODBC Data Source Administrator, first check if you have existing ODBC configuration files called `odbc.ini` and `odbcinst.ini`.

* User DSN files appear in `/Users/[myuser]/Library/ODBC/`.
* System DSN files appear in `/Library/ODBC/`.

**Files Do Not Exist**\
If the files do not already exist in either of the directories above, follow these steps:

<Steps>
  <Step>
    Navigate to the driver install directory. By default, this is `/Applications/CData ODBC Driver for CData Connect/`.
  </Step>

  <Step>
    Open the `etc` folder and copy the `odbc.ini` and `odbcinst.ini` files.
  </Step>

  <Step>
    Copy the files to either the User DSN or System DSN directory.

    * The User DSN directory is `/Users/[myuser]/Library/ODBC/`. If you choose this option, you can only access your connection for the user you install it for.
    * The System DSN directory is `/Library/ODBC/`. If you choose this option, you can access the connection for all users, but copying the files may prompt you for elevated permissions.
  </Step>

  <Step>
    Quit and re-launch the iODBC Data Source Administrator.
  </Step>

  <Step>
    Follow the steps for [Logging in](#logging-in) to complete setup.
  </Step>
</Steps>

**Files Already Exist**\
If you already have ODBC configuration files in one of the directories above, follow these steps:

<Steps>
  <Step>
    Navigate to the driver install directory. By default, this is `/Applications/CData ODBC Driver for CData Connect/`.
  </Step>

  <Step>
    Open the `etc` folder and then open the `odbc.ini` file. Copy the contents to your clipboard.
  </Step>

  <Step>
    Open the existing `odbc.ini` file in the DSN directory.

    * If it is in the User DSN directory (`/Users/[myuser]/Library/ODBC/`), you can open the file directly through Finder.
    * If it is in the System DSN directory (`/Library/ODBC/`), you will need to open the file with elevated permissions. Open a Terminal window and enter:

    ```bash theme={null}
    sudo nano /Library/ODBC/odbc.ini
    ```

    Provide your password when prompted.
  </Step>

  <Step>
    Paste the contents of the `odbc.ini` file from the Driver installation directory into the bottom of the existing `odbc.ini` file in the DSN directory.
  </Step>

  <Step>
    Save your changes. If you are in a terminal window, use the key combination **Control ^**+**O**.
  </Step>

  <Step>
    Repeat steps 2 through 5 above for the `odbcinst.ini` file.
  </Step>

  <Step>
    Quit and re-launch the iODBC Data Source Administrator.
  </Step>

  <Step>
    Follow the steps for [Logging in](#logging-in) to complete setup.
  </Step>
</Steps>

### Linux

Click [here](https://cdn.cdata.com/help/LFG/odbc/pg_connectionodbclinux.htm) for documentation on configuring a DSN on Linux.

## Connect to a Workspace

To connect the ODBC client to a specific [workspace](/en/Workspaces), you specify the workspace name in the **Advanced** tab of the ODBC driver for Connect AI.

<Frame>
  <img alt="ODBC Specify Workspace" />
</Frame>

## Designate a Log File

You can designate a log file for the ODBC driver in the **Advanced** tab of **Connection Properties**. You can also change the verbosity of the log file for greater detail.

<Frame>
  <img alt="ODBC Log File" />
</Frame>

## More Information

To learn more information about using the ODBC Driver for Connect AI, click [here](https://cdn.cdata.com/help/LFM/odbc/default.htm).


# Outsystems
Source: https://docs.cloud.cdata.com/en/Clients/Outsystems-Client

This page outlines the steps to connect Outsystems to Connect AI.

## Prerequisites

Before you can configure and use Outsystems with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI in Outsystems

<Steps>
  <Step>
    Open Outsystems Studio.
  </Step>

  <Step>
    Click the gear icon to open Environment Management.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Administration** and select **Database Connections**.
  </Step>

  <Step>
    Click **New Database Connection**.
  </Step>

  <Step>
    Enter the following information to configure the database connection:

    * **Name**—A name for the connection, such as *Connect AI*.
    * **DBMS**—SQL Server/ Azure SQL.
    * **Username**—The Connect AI user email used during preparation, e.g. [user@mydomain.com](mailto:user@mydomain.com).
    * **Password**—The PAT generated for the Connect AI user above.
    * **Server**—tds.cdata.com,14333.
    * **Schema**—The name of your connection e.g. OData1.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Test Connection**.
  </Step>

  <Step>
    Click **Create** to save the connection.
  </Step>
</Steps>

## Map Tables or Views to Entities in an Extension Module

Once you create the database connection, you can create an extension that maps tables or view to Outsystems entities. To do so, you must create an Entity in Outsystems Integration Studio.

<Steps>
  <Step>
    In Integration Studios, right click **Entities** in the extension tree and click **Connect to External Table or View…**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    A wizard will appear. Follow its steps to select the tables and views to work with. Complete the wizard and return to the integration studio view.
  </Step>

  <Step>
    Click **1-Click Publish**. This opens a 1-Click Publish wizard. Once the process completes, click **Configure**.
  </Step>

  <Step>
    In the Service Center, associate the name of the Logical Database to the Database Connection the Extension Module will use and click **Apply**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the application, click **Manage Dependencies…**.
  </Step>

  <Step>
    Add the dependency to the Extension and select the Tables and Views to map to Entities to use in the application. Click **OK**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>

You can now work with your data as if it was a standard Outsystems Entity.


# Polybase
Source: https://docs.cloud.cdata.com/en/Clients/Polybase-Client

This page outlines the steps to connect Polybase to Connect AI. Ensure Polybase has been installed and enabled before beginning these steps.

<Steps>
  <Step>
    Create a database scoped `CREDENTIAL` for connecting to the SQL Server. It should map `IDENTITY` and `SECRET` to your database's Username and Password respectively. Follow the example below.

    ```sql theme={null}
    CREATE DATABASE SCOPED CREDENTIAL SqlServerCredentials
     WITH IDENTITY = 'yourusername', SECRET = 'yourpassword';
    ```
  </Step>

  <Step>
    Using `CREATE EXTERNAL DATASOURCE`, create an external datasource that names the instance, identifies the external data source, and sets whether computation should be pushed via `PUSHDOWN` to source by default. This uses the `CREDENTIAL` created above. Use the below example as a template.

    ```sql theme={null}
    CREATE EXTERNAL DATA SOURCE SQLServerInstance
     WITH ( LOCATION = 'sqlserver://tds.cdata.com:14333',
     PUSHDOWN = ON,
     CREDENTIAL = SQLServerCredentials);
    ```
  </Step>

  <Step>
    Create the external table using `CREATE EXTERNAL TABLE`. The statement needs collation and the location must be in three-part notation `<database>.<schema>.<table>`. See below for a functional example.

    ```sql theme={null}
    CREATE EXTERNAL TABLE DatabasesExternal (
         name VARCHAR(128) COLLATE SQL_Latin1_General_CP1_CI_AS)
       WITH (LOCATION = 'QuickBooksOnline1.QuickBooksOnline.Accounts',
       DATA_SOURCE = SQLServerInstance);
    ```
  </Step>

  <Step>
    For optimal query performance, you can create statistics on external table columns, as per the code example below.

    ```sql theme={null}
    CREATE STATISTICS statistics_name ON customer (C_CUSTKEY)
     WITH FULLSCAN;
    ```
  </Step>
</Steps>


# PowerBI.com
Source: https://docs.cloud.cdata.com/en/Clients/PowerBI.com-Client

This page outlines the steps to connect PowerBI.com to Connect AI.

## Prerequisites

Before you can configure and use PowerBI.com with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Connect to Connect AI

<Steps>
  <Step>
    Click **Create**, and then navigate to **Get data** > **Choose data source**.
  </Step>

  <Step>
    In the search bar, enter *CData Connect* and click the **CData Connect Cloud Connector**.

    <Frame>
      <img alt="Power BI.com connector" />
    </Frame>

    The **Connect to data source** dialog appears.
  </Step>

  <Step>
    In **Connection settings**, click **Sign in** and enter your Connect AI credentials when prompted.
  </Step>

  <Step>
    Return to **Connection settings** and click **Next**.
  </Step>

  <Step>
    You are now connected to your data source within Connect AI.

    <Frame>
      <img alt="Power BI.com Get data" />
    </Frame>
  </Step>
</Steps>


# Power BI Desktop
Source: https://docs.cloud.cdata.com/en/Clients/PowerBIDesktop-Client

This page outlines the steps to connect Power BI Desktop to Connect AI.

## Prerequisites

Before you can configure and use Power BI Desktop with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Step 1: Connect to Connect AI

<Steps>
  <Step>
    In Power BI Desktop, click **Get Data** to open the Get Data window. In the drop-down list, click **More**.
  </Step>

  <Step>
    Use the search field to find *Connect AI* and click **Connect**.
  </Step>

  <Step>
    Click **Sign in** on the prompt that appears. Depending on your setup, this button may be labeled **Sign in as different user**.
  </Step>

  <Step>
    In the Connect AI dialog, sign in to your Connect AI account.
  </Step>

  <Step>
    Return to Power BI Desktop and click **Connect** in the sign-in prompt. The **Navigator** dialog displays the three types of Connect AI connections: **Connections**, **Derived Views**, and **Workspaces**.
  </Step>
</Steps>

<Frame>
  <img alt="Power BI Desktop Navigator" />
</Frame>

## Step 2: Import Data

After you connect to Connect AI, follow these steps to import data to Power BI Desktop:

<Steps>
  <Step>
    In the **Navigator** dialog, expand the **Connections**, **Derived Views**, or **Workspaces** folder to locate the data to load.
    The data is organized in the Navigator as follows:

    * **Connections** > **Schemas** > **Table/View/Stored Procedure**
    * **Derived Views** > **Derived View**
    * **Workspaces** > **Assets** > **Table/View/Stored Procedure**
      For example, to load a specific table within a connection, expand **Connections**, and then expand the connection name. Expand the appropriate schema and then select the table(s) to load, as shown below.

    <Frame>
      <img alt="Power BI Desktop Navigator Hierarchy" />
    </Frame>
  </Step>

  <Step>
    Check the boxes next to the any data that you want to work with. You can view a preview of the data if you wish.
  </Step>

  <Step>
    Click **Load** or **Transform Data**.

    * **Load** instructs the connector to execute the underlying query to Connect AI.
    * **Transform Data** launches the Query Editor and displays a representative view of the table. To run a custom query through this interface, see [Running a Custom Query](#running-a-custom-query).
  </Step>

  <Step>
    Create Power BI visuals with the data you loaded.
  </Step>
</Steps>

### Running a Custom Query

To run a custom query on your data, select **Transform Data** when you are importing from Connect AI and follow these steps:

<Steps>
  <Step>
    In the Power Query Editor window, select **Advanced Editor** in the **Home** tab of the navigation ribbon.

    <Frame>
      <img alt="Power BI Desktop Advanced" />
    </Frame>
  </Step>

  <Step>
    In the Advanced Editor, enter the text in the following format, replacing the contents of the query with your custom query.
  </Step>
</Steps>

```bash theme={null}
let
     Source = CDataConnectCloud.Contents([Query="SELECT ACCOUNTNUMBER, BILLINGSTREET, BILLINGCITY, BILLINGSTATE FROM [Snowflake3].[NORTHWIND].[ACCOUNT] LIMIT 100"])
  in
     Source
```

<Steps>
  <Step>
    Click **Done** to load your data into Power BI Desktop.
  </Step>
</Steps>


# Python
Source: https://docs.cloud.cdata.com/en/Clients/Python-Client

This page outlines the steps to use the Python connector **cdata-connect-ai** with Connect AI. The PEP 249-compliant connector enables querying and writing real-time data via standard SQL through the Connect AI REST API.

See the [cdata-connect-ai PyPI page](https://pypi.org/project/cdata-connect-ai/) for more information.

## Prerequisites

Before you can configure and use Python with Connect AI, you must have the following:

* Python >=3.10
* `requests` >= 2.28.0
* `ijson` >= 3.1.0
* A data source in your Connect AI account. See [Sources](/en/Sources) for more information.
* A Personal Access Token (PAT). Generate a PAT on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Install the Connector

```bash wrap theme={null}
pip install cdata-connect-ai
```

For pandas integration: install the connector with the `full` extra to enable pandas support.

```bash wrap theme={null}
pip install "cdata-connect-ai[full]"
```

## Connect to Connect AI

The following is an example of Python code connecting to the Connect AI API and performing a query on the Account table in a Salesforce connection. Provide your Connect AI username and password (the password is the PAT you created in the prerequisites).

```python wrap theme={null}
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="you@example.com",
    password="<your_personal_access_token>",
)

with conn.cursor() as cur:
    cur.execute("SELECT * FROM [Salesforce1].[Salesforce].[Account]")
    rows = cur.fetchall()

for row in rows:
    print(row)

conn.close()
```

### Configuration File

Use a [PyHOCON](https://github.com/chimpler/pyhocon) configuration file to keep credentials out of code:

```hocon theme={null}
# config.conf
cdata_api_db {
  username = "you@example.com"
  password = "<your_personal_access_token>"
}
```

The code now refers to the configuration file and does not contain credentials:

```python theme={null}
import cdata_connect_ai

conn = cdata_connect_ai.connect(config_path="config.conf")
```

### Connect to a Workspace

To connect to a Connect AI workspace, add a `workspace` parameter as follows:

```python wrap theme={null}
conn = cdata_connect_ai.connect(
    username="you@example.com",
    password="<your_personal_access_token>",
    workspace="production",
)
```

## Examples

### Parameterized Queries

```python wrap theme={null}
with conn.cursor() as cur:
    cur.execute(
        "SELECT * FROM [DB].[public].[users] WHERE city = %(city)s LIMIT %(limit)s",
        {"city": "New York", "limit": 10},
    )
    rows = cur.fetchall()
```

### Batch Operations

```python wrap theme={null}
with conn.cursor() as cur:
    cur.executemany(
        "INSERT INTO [DB].[public].[cities] (city, id) VALUES (@city, @id)",
        [
            {"@city": {"dataType": 5, "value": "New York"}, "@id": {"dataType": 8, "value": 1}},
            {"@city": {"dataType": 5, "value": "London"},   "@id": {"dataType": 8, "value": 2}},
        ],
    )
```

<Note>
  See [Data Types](/en/API/REST-API#data-types) for `dataType` values and descriptions.
</Note>

### Stored Procedures

```python wrap theme={null}
with conn.cursor() as cur:
    cur.callproc("[DB].[public].[my_procedure]", ("arg1", "arg2"))
    rows = cur.fetchall()
```

### Pandas Integration

```python wrap theme={null}
import cdata_connect_ai
import pandas as pd

conn = cdata_connect_ai.connect(
    username="you@example.com",
    password="<your_personal_access_token>",
)

with conn.cursor() as cur:
    cur.execute("SELECT Id, Name, Industry, AnnualRevenue FROM [Salesforce1].[Salesforce].[Account]")
    columns = [desc[0] for desc in cur.description]
    rows = cur.fetchall()

df = pd.DataFrame(rows, columns=columns)
print(df.head())
print(df.describe())

conn.close()
```

## Connection Options

The following table contains the connection options available for the connector.

| Parameter | Description | Default |
| - | - | - |
| `username` | Authentication username | - |
| `password` | Personal access token | - |
| `config_path` | Path to PyHOCON config file | - |
| `workspace` | Connect AI workspace name | - |
| `timeout` | HTTP request timeout (seconds) | `90` |
| `max_retries` | Retries on transient 5xx errors | `3` |
| `retry_delay` | Base delay between retries (seconds) | `1.0` |


# Qlik Sense
Source: https://docs.cloud.cdata.com/en/Clients/QlikSenseCloud-Client

This page outlines the steps to connect Qlik Sense to Connect AI. You can use either Connect AI Virtual SQL Server API or the Connect AI OData endpoint to connect.

## Prerequisites for Connecting via Virtual SQL Server API

Before you connect via Virtual SQL Server API, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via Virtual SQL Server API

To establish a connection from Qlik Sense to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Qlik Sense.
  </Step>

  <Step>
    On the home dashboard, click **Create** > **Data connection**. Click **+** to create a new connection.

    <Frame>
      <img alt="Qlik Add Connection" />
    </Frame>
  </Step>

  <Step>
    In the **Create data connection** dialog, enter *Microsoft SQL Server* in the search bar. Click the **Microsoft SQL Server** button that appears below.

    <Frame>
      <img alt="Qlik Create SQL Server" />
    </Frame>
  </Step>

  <Step>
    Enter the connection settings.

    * Database Properties
      * **Server**—enter *tds.cdata.com*
      * **Port**—enter *14333*
      * **Database**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
      * **Encrypt**—check this box, but do not upload a certificate file.
      * **Trust Server Certificate**—check this box.
      * **Minimum TLS**—leave as **1.0**.
    * Authentication
      * **Use Trusted Connection**—leave unchecked.
      * **Use NTLM**—leave unchecked.
    * Account properties
      * **User defined credentials**—set this according to your needs.
      * **User name**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
      * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * Leave the settings below Account Properties blank and unchecked.

    <Frame>
      <img alt="Qlik Create SQL Server Detail" />
    </Frame>
  </Step>

  <Step>
    Click **Test connection** to test your entered credentials. If you receive an error, check all fields and try again.
  </Step>

  <Step>
    Click **Create** to create the connection.
  </Step>
</Steps>

Your connection is now available for data analysis.

## Prerequisites for Connecting via OData Endpoint

Before you connect to Connect AI via the OData endpoint, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Create a [Workspace](/en/Workspaces). Later, you will use the **OData Service URL** on that page (*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*) with the relevant workspace name to establish the connection.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via OData Endpoint

To connect to Connect AI using the OData protocol, follow these steps.

<Steps>
  <Step>
    Log in to Qlik Sense.
  </Step>

  <Step>
    On the home dashboard, click **Create** > **Data connection**. Click **+** to create a new connection.

    <Frame>
      <img alt="Qlik Add Connection" />
    </Frame>
  </Step>

  <Step>
    In the **Create data connection** dialog, enter *OData* in the search bar. Click the **OData** connector that appears below.

    <Frame>
      <img alt="Qlik Create OData" />
    </Frame>
  </Step>

  <Step>
    Enter the connection settings for OData.

    * Authentication
      * **OData Service Root**—*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*
      * **Authentication Type**—select **Basic**.
    * Account credentials
      * **User defined credentials**—set this according to your needs.
      * **Credentials name**—enter a user-defined name for your credentials, if necessary.
      * **User name**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
      * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
      * **Auth header**—leave this blank.

    <Frame>
      <img alt="Qlik Create OData Details" />
    </Frame>
  </Step>

  <Step>
    Click **Test connection** to test your entered credentials. If you receive an error, check all fields and try again.
  </Step>

  <Step>
    Click **Create** to create the connection.
  </Step>
</Steps>

Your connection is now available for data analysis.


# Redash
Source: https://docs.cloud.cdata.com/en/Clients/Redash-Client

This page outlines the steps to connect Redash to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Redash to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Redash.
  </Step>

  <Step>
    Click the settings widget on the top right.
  </Step>

  <Step>
    Click **New Data Source**.
  </Step>

  <Step>
    Select **Microsoft SQL Server** as the Data Source Type.
  </Step>

  <Step>
    On the configuration tab, set the following properties:

    * **Database Name**: enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Server**: enter the virtual SQL Server host name (*tds.cdata.com*)
    * **User**: enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**: enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **Port**: enter *14333*
  </Step>

  <Step>
    Click **Create**.
  </Step>

  <Step>
    Click **Test Connection** to ensure that the connection is configured properly.
  </Step>
</Steps>


# Replit Agent
Source: https://docs.cloud.cdata.com/en/Clients/Replit-Client

Replit Agent is an AI-powered coding assistant built into the Replit IDE.

## Prerequisites

Before you can configure and use Replit with Connect AI, you must first do the following:

* Install the Replit IDE.

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

* Base64-encode your Connect AI credentials in the following format: `Base64("email:PAT")`.

* Obtain an OpenAI API key: [https://platform.openai.com/](https://platform.openai.com/).

## Connect Replit to the Connect AI MCP

<Steps>
  <Step>
    Open the official Replit MCP learning template available [here](https://replit.com/@matt/Learn-about-MCP?v=1\&utm_source=matt\&utm_medium=blog\&utm_campaign=mcp-in-3#README.md). This template includes a preconfigured MCP runtime environment and sample configuration.
  </Step>

  <Step>
    In Replit, click **Remix**. Replit does the following:

    * Creates an editable copy of the project.
    * Installs MCP dependencies.
    * Initializes the environment.

    Wait for the environment to fully load before continuing.
  </Step>

  <Step>
    Inside the project is a file named `mcp-server-config.json`. Copy and paste the following into this file. Replace the authorization header with the Base64-encoded credentials obtained in the prerequisites.

    ```json theme={null}
    {
      "systemPrompt": "You are a helpful AI assistant.

    Today's date is {today_datetime}.",
      "llm": {
        "provider": "openai",
        "model": "gpt-4o-mini"
      },
      "mcpServers": {
        "cdata-mcp": {
          "command": "npx",
          "args": [
            "mcp-remote",
            "https://mcp.cloud.cdata.com/mcp",
            "--header",
            "Authorization": "Basic BASE64_ENCODED_EMAIL:PAT" //Authorization obtained in prerequisites
          ]
        }
      }
    }
    ```
  </Step>

  <Step>
    Replit requires an LLM key to run MCP workflows. In the **Replit Chat**, when asked for an LLM key, provide your OpenAI API key. Replit stores this key securely in the **Secrets Manager**.
  </Step>

  <Step>
    You can now open the **Replit Chat** panel and issue MCP commands.

    For example, enter the prompt `"List all MCP tools."` The output looks like the following:

    <Frame>
      <img alt="Replit Test Output" />
    </Frame>
  </Step>

  <Step>
    To test whether Replit can communicate with the CData MCP successfully, enter the prompt: `"Show me all available catalogs."` Replit should return a list of catalogs from Connect AI.
  </Step>

  <Step>
    You can now query your connected data source(s) in Connect AI using the Replit's LLM.
  </Step>
</Steps>


# Retool
Source: https://docs.cloud.cdata.com/en/Clients/Retool-Client

You can connect Retool to Connect AI via the OpenAPI specification or via the Virtual SQL Server API. Follow the prerequisites and steps for the method you want to use.

## Prerequisites for Connecting via OpenAPI

Before you connect via OpenAPI, you must first do the following:

* In Connect AI:
  * Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
  * [Add a workspace](/en/Workspaces#add-a-workspace) to Workspaces.
  * [Add assets](/en/Workspaces#workspace-assets) to your workspace.
  * Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.
* In Retool:
  * Go to **Settings** > **API** and click **Create new** to generate an access token. See the [Retool documentation](https://docs.retool.com/org-users/guides/retool-api/authentication) for more information.

## Connect to Connect AI via OpenAPI

To establish a connection from Retool to Connect AI via OpenAPI, follow these steps.

<Steps>
  <Step>
    In **Workspaces** in Connect AI, select a workspace and copy the OpenAPI URL for the workspace. Keep the default options. See [OpenAPI](/en/API/OpenAPI) for more information.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Log in to Retool.
  </Step>

  <Step>
    In the **Resources** tab, click **Create new** > **Resource**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the **Select a resource type** search bar, enter *OpenAPI*.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **OpenAPI**. The **Configure OpenAPI** screen appears.
  </Step>

  <Step>
    Enter the following information to configure the OpenAPI connector:

    * **Name**—the name to use to identify the connector.
    * **Specification URL**—the OpenAPI URL you copied in Connect AI. Paste the URL here.
    * **Forward headers when fetching OpenAPI spec**—must be selected.
    * **Headers**—Authorization is *Basic*. Then, Retool requires that you Base64 encode your Connect AI username and PAT using the input format *username:PAT*. The PAT is the token you created in the prerequisites. You can use a tool such as the one [here](https://www.base64encode.org/). Click **Encode** and copy the Base64 encoded result into this field. For example, for *[test@cdata.com](mailto:test@cdata.com):12345*, the Base64 encoded value is *dGVzdEBjZGF0YS5jb206MTIzNDU=*.
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Test connection** to test your connection configuration.
  </Step>

  <Step>
    Once you have a successful connection, click **Create resource**.
  </Step>

  <Step>
    Create the app in Retool in which to integrate your data.
  </Step>

  <Step>
    Click **Create resource query**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Select the new resource you created, and view the endpoints that are available.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    You can now build your app with the data.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>

## Prerequisites for Connecting via Virtual SQL Server API

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI via Virtual SQL Server API

To establish a connection from Retool to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Retool.
  </Step>

  <Step>
    Under **Resources**, click **Connect a resource**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter "Microsoft SQL" in the search bar and click the resulting option.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Enter the connection settings.

    * **Name**—a name for the connection to Connect AI
    * **Host**—*tds.cdata.com*
    * **Port**—*14333*
    * **Database name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Database username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Database password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Test connection**. If it succeeds, you can click **Create resource**. Your connection to Connect AI is ready to use.
  </Step>
</Steps>


# SAP Analytics Cloud
Source: https://docs.cloud.cdata.com/en/Clients/SAPAnalyticsCloud-Client

This page outlines the steps to connect SAP Analytics Cloud to Connect AI using the [OData](/en/API/OData-Dashboard) protocol. This requires the use of workspaces. See the [Workspaces](/en/Workspaces) documentation for more information.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Create a [Workspace](/en/Workspaces). Later, you will use the **OData Service URL** on that page (*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*) with the relevant workspace name to establish the connection.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from SAP Analytics Cloud to Connect AI using the OData protocol, follow these steps.

<Steps>
  <Step>
    From the SAP Analytics Cloud dashboard, open the navigation menu and click **Connections**.

    <Frame>
      <img alt="SAP Connections" />
    </Frame>
  </Step>

  <Step>
    On the Connection page, click **Add Connection**.

    <Frame>
      <img alt="SAP Add Connection" />
    </Frame>
  </Step>

  <Step>
    In the **Select a data source** dialog, type *odata* into the search bar and select **OData Services**. You can also find it listed under the **Acquire Data** category without searching.
  </Step>

  <Step>
    Configure the connection:

    * Enter a **Connection Name** and, optionally, a **Description**.
    * **Data Service URL**—enter *[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*
    * **Authentication Type**—select **Basic Authentication**.
    * **User Name**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="SAP Connection Fields" />
    </Frame>
  </Step>

  <Step>
    Click **Create** to save the connection.
  </Step>
</Steps>

## Query Your OData API

After establishing the connection to your Connect AI OData API, you can access it as a data source in SAP Analytics Cloud. Follow these steps to access it:

<Steps>
  <Step>
    In SAP Analytics Cloud, open the navigation menu and click **Datasets** or **Modeler**.
  </Step>

  <Step>
    In the **Create New** section, click **From a Data Source**.

    <Frame>
      <img alt="SAP Create New" />
    </Frame>
  </Step>

  <Step>
    In the **Select a data source** dialog, select **OData Services**.
  </Step>

  <Step>
    In the **Connection** drop-down menu, select the connection you created. If you are using the Modeler tab, select the **Create a new query** radio button.

    <Frame>
      <img alt="SAP Select Source" />
    </Frame>
  </Step>

  <Step>
    Click **Next** and build your query according to your needs.
  </Step>
</Steps>

For information about refreshing the data from your OData API, please see [this SAP Analytics Cloud help article](https://help.sap.com/viewer/00f68c2e08b941f081002fd3691d86a7/release/en-US/6aa6a99d4eb5467896c4fd47bc9c7642.html).


# SAS Viya
Source: https://docs.cloud.cdata.com/en/Clients/SASViya-Client

This page outlines the steps to install and configure the Connect AI connector for SAS Viya. After installation, SAS Viya can pull data from sources that you have connected to your Connect AI account.

## Prerequisites

Before you can configure and use SAS Viya with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

You must also generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from SAS Viya to Connect AI through the JDBC driver, follow these steps.

<Steps>
  <Step>
    Download and install the Connect AI JDBC driver.

    a. Open the **Integrations** page of Connect AI.

    b. In the **Dev Tools** section, click **JDBC**.

    c. Download and run the setup file.

    d. When the installation is complete, the JAR file can be found in the installation directory.
  </Step>

  <Step>
    Log in to SAS Viya.
  </Step>

  <Step>
    Click on the navigation button on the upper left.
  </Step>

  <Step>
    Click **Develop Code and Flows**.

    <Frame>
      <img alt="SAS Visual Analytics Client 01" />
    </Frame>
  </Step>

  <Step>
    Upload the Connect AI JDBC JAR file.

    * Right click on a directory.
    * Click on **Upload Files**.
    * Choose the Connect AI JDBC JAR file.
  </Step>

  <Step>
    Place the JAR file of the Connect AI JDBC driver in any directory and note its file path.

    <Frame>
      <img alt="SAS Visual Analytics Client 02" />
    </Frame>
  </Step>

  <Step>
    Click on the **Libraries** icon in the left vertical navigation bar.
  </Step>

  <Step>
    Click on the connection symbol in the top left under **Libraries** to create a new library for the JDBC connection.

    <Frame>
      <img alt="SAS Visual Analytics Client 03" />
    </Frame>
  </Step>

  <Step>
    Enter the library connection settings.

    * **Connection name**—enter a name for your connection
    * **Library name (libref)**—enter a reference for your library
    * **Library type**—choose **SAS/ACCESS to JDBC**

    <Frame>
      <img alt="SAS Visual Analytics Client 04" />
    </Frame>
  </Step>

  <Step>
    Click the **Properties** tab and set **Library attributes** to **READONLY**.

    <Frame>
      <img alt="SAS Visual Analytics Client 05" />
    </Frame>
  </Step>

  <Step>
    Click the **Connection Options** tab and enter the following details.

    * **Hive JDBC driver's class name**—enter *cdata.jdbc.connect.ConnectDriver*
    * **Java CLASSPATH**—enter the file path to the JAR driver file

    <Frame>
      <img alt="SAS Visual Analytics Client 06" />
    </Frame>

    <Frame>
      <img alt="SAS Visual Analytics Client 07" />
    </Frame>
  </Step>

  <Step>
    Click on **Test connection**. If it succeeds, click **Save and connect**.
  </Step>

  <Step>
    Click the "+" to add a new tab and select **SAS program**.

    <Frame>
      <img alt="SAS Visual Analytics Client 08" />
    </Frame>
  </Step>

  <Step>
    Fill in the code block below with your setup parameters.

    * **Libref**—enter the library reference you defined in Step 9.
    * **ClassPath**—enter the file path to the JAR driver file.
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **DefaultCatalog**—enter the connection configured in Connect AI that you want to query.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
  </Step>

  <Step>
    Click **Run**. You can see the data load from Connect AI into SAS Viya.
  </Step>
</Steps>

```bash theme={null}
libname [Libref] JDBC  
classpath=[ClassPath] 
class="cdata.jdbc.connect.ConnectDriver"    
URL="jdbc:Connect:AuthScheme=Basic;User=[Username];DefaultCatalog=[DefaultCatalog];DefaultSchema=dbo;Password=[Password]";
proc sql;
SELECT * FROM [Libref].MyTable;
quit;
```


# Salesforce Lightning Connect
Source: https://docs.cloud.cdata.com/en/Clients/SFLC-Client

This page outlines the steps to connect Salesforce Lightning Connect to Connect AI using the [OData](/en/API/OData-Dashboard) protocol. This requires the use of workspaces. See the [Workspaces](/en/Workspaces) documentation for more information.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Create a [Workspace](/en/Workspaces). Later, you will use the **OData Service URL** on that page (*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*) with the relevant workspace name to establish the connection.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

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

<Steps>
  <Step>
    Open Salesforce Setup (lightning experience).
  </Step>

  <Step>
    Navigate to **Integrations** > **External Data Sources** or type *external data sources* into the search bar.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **New External Data Source** at the top of the table.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Configure the data source fields:

    * Enter labels for the **External Data Source** and **Name** fields. -**Type**—select **Salesforce Connect: OData 4.0**
    * **URL**—enter *[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*
    * Under **Authentication**, for **Identity Type**, select **Named Principal**.
    * **Authentication Protocol**—select **Password Authentication**.
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Save** to save your external data source.
  </Step>
</Steps>

## Create External Objects from Data

After you create your external data source, you must create external objects out of the data that you want to access in Salesforce Lightning Connect. Open your newly-created external data source and follow these steps:

<Steps>
  <Step>
    In the top button bar, click **Validate and Sync**.
  </Step>

  <Step>
    Check the **Select** box next to each table that you want to sync to Salesforce. If desired, also check the **Sync in background** box.
  </Step>

  <Step>
    Click **Sync** to synchronize the tables.
  </Step>
</Steps>

Your Connect AI external objects can be accessed and used like standard Salesforce objects. Salesforce has documentation about [external objects](https://developer.salesforce.com/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_external_objects.htm) and their uses.

### Access External Objects

To manage your external objects, you can use one of the following methods:

* Open your Connect AI connection in the **Integrations** > **External Data Sources** menu.
  * Your synchronized tables appear under the **External Objects** field.
  * Each table has buttons for **Edit**, **Erase**, and **Validate**.
  * Click the name of a table to open it in Object Manager.
* Alternatively, navigate to **Integrations** > **External Objects** or type *external objects* into the search bar.
  * Your synchronized tables appear in the External Objects list with **Edit** and **Erase** options.
  * You can click the label of an object to open its details, or you can click the name of the External Data Source to open your connection information.


# SQL Server Linked Server
Source: https://docs.cloud.cdata.com/en/Clients/SQLServerLinked-Client

This page outlines the steps to connect SQL Server Linked Server to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from SQL Server Linked Server to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Open Microsoft SQL Server Management Studio.
  </Step>

  <Step>
    In the **Object Explorer** pane, open **Server Objects**, right-click **Linked Servers**, and select **New Linked Server**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    The **New Linked Server** dialogue opens. On the **General** page, enter the following information:

    * Enter a memorable name for the server in the **Linked server** field.
    * Select the radio button **Other data source** and select **Microsoft OLE DB Driver for SQL Server** as the provider.
    * In the **Data source** field, enter *tds.cdata.com*,*14333*
    * Leave the other fields empty.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Select the **Security** page. At the bottom, select the radio button labeled **Be made using this security context** and enter the following information:

    * **Remote login**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **With password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **OK** to create the server.
  </Step>
</Steps>

Your linked server can now be used to access the data in the data source you specified. If you need to access data from more sources, create another linked server for each one.


# SSIS
Source: https://docs.cloud.cdata.com/en/Clients/SSIS-Client

This page outlines the steps to use the SSIS Components for Connect AI.

## Prerequisites

Before you can configure and use SSIS with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

## Install the Provider

Follow these steps to download and install the Components:

<Steps>
  <Step>
    Open the **Integrations** page of Connect AI.
  </Step>

  <Step>
    In the **Dev Tools** section, click **SSIS**.
  </Step>

  <Step>
    Download and run the setup file.
  </Step>

  <Step>
    The installer can automatically detect software that supports SSIS. Select the options that you want the installer to configure.
  </Step>
</Steps>

## Connect to Connect AI

To add a new Connect AI connection to the SSIS package, follow these steps:

<Steps>
  <Step>
    Right-click within the Connection Manager window and select **New Connection** from the menu.
  </Step>

  <Step>
    Choose the **Connect AI Connection Manager** from the Add SSIS Connection Manager window.
  </Step>

  <Step>
    The OAuth endpoint opens in your default web browser. Log in to complete the OAuth process.
  </Step>
</Steps>

Alternatively, you can create a new connection directly using the Connect AI Source or the Connect AI Destination. You can set the connection properties in the Connect AI Connection Manager window.

## Connect to a Workspace

To connect the SSIS client to a specific [workspace](/en/Workspaces), you specify the workspace name in the **Workspace** field of the Connect AI Connection Manager.

<Frame>
  <img alt="" />
</Frame>

## Learn More

To learn more information about using the SSIS Components for Connect AI, click [here](https://cdn.cdata.com/help/LFM/rssis/default.htm).


# Salesforce External Services
Source: https://docs.cloud.cdata.com/en/Clients/SalesforceExternal-Client

The page outlines the steps to connect Salesforce External Services to Connect AI using OpenAPI. This requires the use of workspaces and an OpenAPI specification file.

## Prerequisites

Before you can add an external service in Salesforce, you must create a named credential in Salesforce. In Salesforce Setup, select **Settings** > **Security** > **Named Credentials** to create a named credential.

Before you connect via OpenAPI, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* [Add a workspace](/en/Workspaces#add-a-workspace) to Workspaces.
* [Add assets](/en/Workspaces#workspace-assets) to your workspace.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect via OpenAPI

To establish a connection from Salesforce External Services to the Connect AI via OpenAPI, follow these steps.

<Steps>
  <Step>
    In the **Workspaces** screen in Connect AI, select a workspace and download the OpenAPI specification for the workspace. See [OpenAPI](/en/API/OpenAPI) for more information.

    <Note>
      Select OpenAPI version 3.0. Leave **Convert array types to strings** off.
    </Note>
  </Step>

  <Step>
    Log in to Salesforce.
    In Salesforce Setup, select **Platform Tools** > **Integrations** > **External Services**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Add an External Service**.
  </Step>

  <Step>
    Click **Select an API source from API Specification** and click **Next**.
  </Step>

  <Step>
    In **Provide Registration Details**, enter the following:

    * **External Service Name**—an identifying name for your external service.
    * **Description**—a description of your external service.
    * **Service Schema**—select **Upload from local**.
    * **Select a Named Credential**—select the named credential you created.
  </Step>

  <Step>
    Upload the JSON file you downloaded from Connect AI.
  </Step>

  <Step>
    If the schema validation was successful, click **Save & Next**.
  </Step>

  <Step>
    The next step is **Select Operations**. These operations are all the actions of the connector that are contained in the OpenAPI specification file. The actions include all the functions you need for the table, including list, get, create, update, and delete records. The actions include a description, input parameters, and output parameters.

    <Frame>
      <img alt="" />
    </Frame>

    The input parameters are appended to the URL, such as `$top`, `$filter`, and `$orderby`. See [API Operations](/en/API/OpenAPI#api-operations) for a complete parameter reference. The input parameters are based on OData filtering.
    Select the operations you want to include in the external service.
  </Step>

  <Step>
    Review the actions for your external service, including the input and output parameters. If you need to change input or output parameters, you need to edit the OpenAPI specification file.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Finish**. Your external service appears in the list of external services for Salesforce and is now available to build flows.
  </Step>
</Steps>


# SnapLogic
Source: https://docs.cloud.cdata.com/en/Clients/SnapLogic-Client



## Prerequisites

Before you can configure and use SnapLogic with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

You must also generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

<Steps>
  <Step>
    Download and install the Connect AI JDBC driver.

    a. Open the **Integrations** page of Connect AI.

    b. In the **Dev Tools** section, click **JDBC**.

    c. Download and run the setup file.

    d. When the installation is complete, the JAR file can be found in the installation directory. The default directory is `C:/Program Files/CData/CData Connect JDBC driver/lib`.
  </Step>

  <Step>
    Log in to SnapLogic.
  </Step>

  <Step>
    Click the **Manager** tab.
  </Step>

  <Step>
    Select a folder on the left to add the JDBC JAR file to.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click the **Files** tab.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click the "+" button in the top right to upload the Connect AI JDBC JAR file. It appears as a file once uploaded.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click the **Designer** tab.
  </Step>

  <Step>
    Click **JDBC** to expand the options for snaps.
  </Step>

  <Step>
    Click and drag a **Generic JDBC - Select** snap onto the designer.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Add Account** > **Continue**.
  </Step>

  <Step>
    Enter the JDBC connection properties.

    * **JDBC driver**—add the Connect AI JAR file
    * **JDBC driver Class**—enter *cdata.jdbc.connect.ConnectDriver*
    * **JDBC Url**—enter a JDBC connection string for the JDBC driver. The connection string is formatted like `jdbc:connect:AuthScheme=[AuthScheme];User=[User];Password=[PAT];`.
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Validate**. If the connection succeeds, the snap is ready to use.
  </Step>

  <Step>
    Click **Apply**.
  </Step>
</Steps>


# Tableau Cloud
Source: https://docs.cloud.cdata.com/en/Clients/TableauCloud-Client

This page outlines the steps to connect Tableau Cloud to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Connections](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.
* If you want to connect to a workspace rather than a data source, first [Add a workspace](/en/Workspaces#add-a-workspace) to Workspaces.

## Connect to Connect AI

To establish a connection from Tableau Cloud to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Tableau Cloud.
  </Step>

  <Step>
    On the **Home** tab, click **New** > **Workbook**.

    <Frame>
      <img alt="Tableau Cloud New Connection" />
    </Frame>
  </Step>

  <Step>
    On the **Connect to Data** dialog, select the **Connectors** tab. In the connectors list, select **Microsoft SQL Server**.

    <Frame>
      <img alt="Tableau Cloud Select Source" />
    </Frame>
  </Step>

  <Step>
    Enter the connection settings.

    * **Server**—enter the Virtual SQL Server endpoint and port separated by a comma: *tds.cdata.com*,*14333*
    * **Database**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Authentication**—leave this as username and password.
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **Require SSL**—leave this selected.
  </Step>

  <Step>
    Click **Sign In**.
  </Step>

  <Step>
    Once the connection succeeds, your data is available to use in your workbook. Follow these steps to access it:
  </Step>

  <Step>
    In the **Connections** section of the data pane to the left of the workbook, select your connection.
  </Step>

  <Step>
    In the **Database** section of the data pane, select the data source that you want to use. The tables for that data source populate in the **Table** section.
  </Step>

  <Step>
    Drag your tables into the workbook space or perform queries as needed.
  </Step>
</Steps>

## Modify a Connection

You can modify your connection by following these steps:

<Steps>
  <Step>
    In your workbook, click the drop-down arrow next to your connection in the **Connections** section.
  </Step>

  <Step>
    Select **Edit Connection**.

    <Frame>
      <img alt="Tableau Cloud Edit Connection" />
    </Frame>
  </Step>

  <Step>
    Edit your connection details and click **Sign In** when you are finished.
  </Step>
</Steps>

## Connect to a Workspace

To connect Tableau Cloud to a specific [workspace](/en/Workspaces) in Connect AI, you specify the workspace name after the Connect AI username in the format of `[your_email_address]@[workspace_name]`:

<Frame>
  <img alt="Tableau Cloud Workspace" />
</Frame>

You can copy the **Username** from the **Virtual SQL Server** tab of the **Endpoints** dialog for your workspace and paste it in the Tableau Cloud **Username** field.

<Frame>
  <img alt="Tableau Cloud Endpoints" />
</Frame>

## Learn More

For more information about Tableau Cloud, please see the [Tableau Cloud help pages](https://help.tableau.com/current/online/en-us/tableau-online-home.htm).


# Tableau Desktop
Source: https://docs.cloud.cdata.com/en/Clients/TableauDesktop-Client

This page outlines the steps to connect Tableau Desktop to Connect AI.

## Prerequisites

Before you can configure and use Tableau Desktop with Connect AI, you must first connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

There are two ways to establish this connection, each with its own benefits and drawbacks:

* **Using the Tableau Desktop Connector**: This method provides the best performance for your reports. However, reports created using this method cannot be published, so they are limited to the local environment. This method is recommended unless you need to publish your reports.
* **Using the Virtual SQL Server API**: This method allows you to publish your reports outside the local environment. However, the performance of this method might not meet the same standard as the connector. This method is only recommended if you need to publish your reports.

Follow the steps below for your chosen connection method.

## Method 1: Use the Connector

The Tableau Desktop Connector for Connect AI can be used to establish a connection in both the desktop and server editions of Tableau. The connector includes comprehensive high-performance data access, real-time integration, extensive metadata discovery, and robust SQL-92 support.

### Step 1: Install the Connector

Follow the directions below for your environment.

#### Tableau Desktop

**Prerequisites**

Before you start, you must have a supported Tableau application installed. Supported applications include:

* Tableau Desktop 2020.1 or later
* Tableau Prep 2020.4.1 or later.

For older versions of Tableau Desktop, please use either [ODBC](/en/Clients/ODBC-Client) or [JDBC](/en/Clients/JDBC-Client) instead.

**Installation Instructions**

Once the prerequisites are satisfied, follow these steps to install the connector:

<Steps>
  <Step>
    Open the **Integrations** page of Connect AI.
  </Step>

  <Step>
    In the **BI and Reporting Tools** section, click **Tableau Desktop**.
  </Step>

  <Step>
    Download and run the setup file. If Tableau Desktop is running during installation, you will need to close and reopen it after the installation finishes.
  </Step>

  <Step>
    Once the installation is complete, click **Finish**.
  </Step>
</Steps>

If you have Tableau Desktop 2020.3 or later, the setup automatically attempts to register the driver with your Tableau install. By default, the driver `.jar` file is placed into:

* Windows: `C:\Program Files\Tableau\Drivers`
* Mac: `/Users/myuser/Library/Tableau/Drivers`

By default, the connector `.taco` file is placed into:

* Windows: `C:\Users\myuser\Documents\My Tableau Repository\Connectors`
* Mac: `/Users/myuser/Documents/My Tableau Repository/Connectors`

**Manual Registration**

If you are using Tableau Prep or a version of Tableau Desktop earlier than 2020.3, the Connect AI Connector setup will not be able to detect your Tableau install. After completing setup, you will need to register the connector manually by following these steps:

<Steps>
  <Step>
    Find the connector install directory. By default, this is `C:\Program Files\CData\Tableau Connector for CData Connect 2021` for Windows and `/Applications/Tableau Connector for CData Connect 2021` for MacOS.
  </Step>

  <Step>
    Find your Tableau repository. Your repository is usually located in your documents folder with the name `My Tableau Repository`. If you are using Prep, it is called `My Tableau Prep Repository`.
  </Step>

  <Step>
    Open the Tableau install directory and open the `lib` directory. Copy `cdata.Cloud.legacy.taco` into the `Connectors` directory within your Tableau repository.
  </Step>
</Steps>

<Note>
  As of Tableau Prep 21.2+, standard taco files are supported instead of legacy taco files.
</Note>

#### Tableau Server

**Prerequisites**

Before you start, you must have a supported Tableau application installed. This includes Tableau Server 2020.1 or later.

For older versions of Tableau Server, please use either the [CData ODBC Driver](/en/Clients/ODBC-Client) or the [JDBC driver for Connect AI](/en/Clients/JDBC-Client) instead.

<Note>
  If a connector has the same class as a connector previously registered, the new one will be rejected.
</Note>

**Install Instructions**

Once the prerequisites are satisfied, follow these steps to install the connector:

<Steps>
  <Step>
    Open the **Integrations** page.
  </Step>

  <Step>
    In the **BI and Reporting Tools** section, click **Tableau Desktop**.
  </Step>

  <Step>
    Download and run the setup file. If Tableau Server is running during installation, you will need to close and reopen it after the installation finishes.
  </Step>

  <Step>
    Once the installation is complete, click **Finish**.
  </Step>

  <Step>
    A JAR file will be automatically placed in the Drivers directory, which is `C:\Program Files\Tableau\Drivers` by default. This file needs to remain here for the connector to function properly.
  </Step>

  <Step>
    Make sure that the license file (.lic) is placed alongside the JAR in the `Drivers` folder.
  </Step>

  <Step>
    Drop the `.taco` file into `[RootDirectory]/data/tabsvc/vizqlserver/Connectors`. The root directory is likely to be `ProgramData` on the drive Tableau Server is installed on.
  </Step>

  <Step>
    Restart the server.
  </Step>

  <Step>
    To use an unsigned packaged connector, optionally disable signature verification by setting `native_api.disable_verify_connector_plugin_signature` to `true` via TSM.
  </Step>
</Steps>

### Step 2: Connecting to Connect AI

Once the connector is installed, open Tableau Desktop or Tableau Server and perform the following steps:

<Steps>
  <Step>
    In the **Connect** sidebar menu, under the **To a Server** category, click **More…**
  </Step>

  <Step>
    Use the search field or locate and click **CData Connect by CData**.
  </Step>

  <Step>
    A sign-in prompt appears. Click **Sign In**.
  </Step>

  <Step>
    Sign in to your Connect AI account.
  </Step>

  <Step>
    After signing in, or if you are already signed in, your connection appears in the **Connections** pane on the left.
  </Step>
</Steps>

You can now use the desired Schema in Tableau.

## Method 2: Use Virtual SQL Server

As an alternative to downloading and installing the connector, you can connect to the Connect AI Virtual SQL Server API. This method is only recommended if you need to publish your reports.

### Prerequisites

Before you connect, you must first generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page of Connect AI. Copy this down, as it acts as your password during authentication.

<img />

### Connect to Connect AI

To establish a connection from Tableau Desktop to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    In Tableau Desktop, open a new book. Under **To a Server**, select **More**, then **Microsoft SQL Server**.

    <Frame>
      <img alt="Tableau Desktop SQL" />
    </Frame>
  </Step>

  <Step>
    Enter your credentials:

    * **Server**—enter the Virtual SQL Server endpoint and port separated by a comma: *tds.cdata.com*,*14333*
    * **Database**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Authentication**—select **Use a specific username and password**.
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **Require SSL**—leave this selected.

    <Frame>
      <img alt="Tableau Desktop Login" />
    </Frame>
  </Step>

  <Step>
    Click **Sign In**. The authentication process may take a few minutes.
  </Step>
</Steps>

After you successfully sign in, you can access your data in the Tableau Desktop sidebar to create and publish reports.

## Learn More

To learn more information about using the Tableau Connector for Connect AI, click [here](https://cdn.cdata.com/help/LFG/tableau/default.htm).


# ThoughtSpot
Source: https://docs.cloud.cdata.com/en/Clients/ThoughtSpot-Client

This page outlines the steps to connect ThoughtSpot to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from ThoughtSpot to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to ThoughtSpot.
  </Step>

  <Step>
    On the top navigation bar, click **Data**.
  </Step>

  <Step>
    Click **Create new** > **Connection**.

    <Frame>
      <img alt="ThoughtSpot Client 01" />
    </Frame>
  </Step>

  <Step>
    Name the connection and click "SQL Server".

    <Frame>
      <img alt="ThoughtSpot Client 02" />
    </Frame>
  </Step>

  <Step>
    Click **Continue** on the top right.
  </Step>

  <Step>
    Enter the connection settings.

    * **Host**—*tds.cdata.com*
    * **Port**—*14333*
    * **User**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **Database**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).

    <Frame>
      <img alt="ThoughtSpot Client 03" />
    </Frame>
  </Step>

  <Step>
    Click **Continue**.
  </Step>

  <Step>
    If the connection succeeds, a list of tables is displayed as shown below.

    <Frame>
      <img alt="ThoughtSpot Client 04" />
    </Frame>
  </Step>

  <Step>
    Click **Create Connection**.
  </Step>
</Steps>


# Windsurf
Source: https://docs.cloud.cdata.com/en/Clients/Windsurf-Client

Windsurf is an AI-powered integrated development environment (IDE) developed by Codeium. It combines intelligent coding assistance with a collaborative Flow system for seamless human-AI interaction.

Connect AI uses OAuth authentication by default, but you can also use Basic authentication with a Personal Access Token (PAT).

## Prerequisites

Before you can configure and use Windsurf with Connect AI, you must first do the following:

* Install the Windsurf IDE (MCP integrations do not support extensions or plugins).

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.

* (Basic authentication only) Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

* (Basic authentication only) Base64-encode your Connect AI credentials in the following format: `Base64("email:PAT")`.

## Connect Windsurf to the Connect AI MCP

Open the MCP configuration file, then choose an authentication method.

<Steps>
  <Step>
    Open Cascade Code Chat Assistant, either by pressing CTRL+L or by clicking the button highlighted below.

    <Frame>
      <img alt="Windsurf Chat Assistant" />
    </Frame>
  </Step>

  <Step>
    In Windsurf, open the MCP configuration file, `mcp_config.json`, which is created during installation. The default path is `C:\Users\<YourUsername>\.codeium\windsurf\mcpconfig.json`. You can also open it directly from the IDE by clicking the MCPs button in the chat dialog, and then selecting the **Config** icon, as shown below:

    <Frame>
      <img alt="Windsurf config file" />
    </Frame>
  </Step>
</Steps>

### OAuth Authentication

<Steps>
  <Step>
    Copy and paste the following into the `mcp_config.json` file.

    ```json theme={null}
    {
      "mcpServers": {
        "cdata-mcp": {
          "serverUrl": "https://mcp.cloud.cdata.com/mcp"
        }
      }
    }
    ```
  </Step>

  <Step>
    Start the MCP server by clicking the **MCPs** button in the chat dialog and clicking the **Refresh** button. Windsurf detects that the server requires OAuth and prompts you to log in. Windsurf opens your browser to the Connect AI sign-in page. Complete the sign-in to authorize the connection.

    <Frame>
      <img alt="Windsurf start MCP server" />
    </Frame>

    Once the MCP server is started, a green indicator appears.
  </Step>
</Steps>

### Basic Authentication

<Steps>
  <Step>
    Copy and paste the following into the `mcp_config.json` file. Replace the authorization header with the Base64-encoded credentials obtained in the prerequisites.

    ```json theme={null}
    {
      "mcpServers": {
        "cdata-mcp": {
          "serverUrl": "https://mcp.cloud.cdata.com/mcp",
          "headers": {
            "Authorization": "Basic YOUR_BASE64_ENCODED_EMAIL:PAT" //Authorization obtained in the prerequisites
          }
        }
      }
    }
    ```
  </Step>

  <Step>
    Start the MCP server by clicking the **MCPs** button in the chat dialog and clicking the **Refresh** button.

    <Frame>
      <img alt="Windsurf start MCP server" />
    </Frame>

    Once the MCP server is started, a green indicator appears.
  </Step>
</Steps>

## Chat with Windsurf

You can now chat with the assistant. Windsurf lists the available tools, the connections, and a result set of a given table of a given connection.

<Frame>
  <img alt="Windsurf sample chat" />
</Frame>


# Workato
Source: https://docs.cloud.cdata.com/en/Clients/Workato-Client

This page outlines the steps to connect Workato to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Workato to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Workato.
  </Step>

  <Step>
    On the navigation bar, click **Projects**.
  </Step>

  <Step>
    Enter a name for the new project and click **Create project**.
  </Step>

  <Step>
    In your new project, click **Create** > **Connection**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In the search bar, enter "SQL Server". The **Connect to SQL Server** screen appears.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In **Connect to SQL Server**, enter the connection name and the following connection settings.

    * **Location**—The name of the project in which to create the connection.
    * **Connection type**—select **Cloud**.
    * **Host**—*tds.cdata.com*
    * **Port**—*14333*
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **Database**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
  </Step>

  <Step>
    Click **Connect**. A **Connection established** message appears.
  </Step>

  <Step>
    The next step is to set up your recipe. In your project, click **Create** > **Recipe**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    In **Set up your recipe**, enter the name and location of your recipe.
  </Step>

  <Step>
    Select **Run on a schedule**.
  </Step>

  <Step>
    Select the actions that occur on the schedule.
  </Step>

  <Step>
    Select a table from your SQL Server connection, and any filters, if applicable.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Save** to save the recipe.
  </Step>

  <Step>
    Click **Test Jobs** to test your recipe.
  </Step>
</Steps>


# Zapier
Source: https://docs.cloud.cdata.com/en/Clients/Zapier-Client

This page outlines the steps to connect Zapier to Connect AI using the [OData](/en/API/OData-Dashboard) protocol. This requires the use of workspaces. See the [Workspaces](/en/Workspaces) documentation for more information.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Create a [Workspace](/en/Workspaces). Later, you will use the **OData Service URL** on that page (*[https://cloud.cdata.com/api/odata/\{workspace\\\_name}](https://cloud.cdata.com/api/odata/\{workspace\\_name})*) with the relevant workspace name to establish the connection.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

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

<Steps>
  <Step>
    Log in to Zapier.
  </Step>

  <Step>
    Click **Create Zap**.
  </Step>

  <Step>
    In the dialog that appears, search for "Webhooks by Zapier", and click the option underneath.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Under Event, select **Retrieve Poll**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Fill in the connection details:

    * **URL**: Enter the OData URL.
    * **Key**: Enter "value.name".
    * Authentication details: Fill in **Basic Auth** or **Headers**. The basic option requires a user and password separated by a pipe (`|`) symbol. The headers option requires a request type header with encoded credentials.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Click **Test**. If the connection is set up properly, sample records will appear.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>
</Steps>


# Zoho Analytics
Source: https://docs.cloud.cdata.com/en/Clients/ZohoAnalytics-Client

This page outlines the steps to connect Zoho Analytics to the Connect AI Virtual SQL Server API.

## Prerequisites

Before you connect, you must first do the following:

* Connect a data source to your Connect AI account. See [Sources](/en/Sources) for more information.
* Generate a Personal Access Token (PAT) on the [Settings](/en/Settings/Personal-Access-Tokens) page. Copy this down, as it acts as your password during authentication.

## Connect to Connect AI

To establish a connection from Zoho Analytics to the Connect AI Virtual SQL Server API, follow these steps.

<Steps>
  <Step>
    Log in to Zoho Analytics.
  </Step>

  <Step>
    Create a new connection and select **Other Cloud Services** to open the connection dialog.
  </Step>

  <Step>
    Enter the following information:

    * **Database Type**—select *MS SQL Server*.
    * **Endpoint**—enter *tds.cdata.com*
    * **SQL Server Instance Name**—leave this blank.
    * **Port**—enter *14333*
    * **Username**—enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
    * **Password**—enter the PAT you generated on the [Settings](/en/Settings/Personal-Access-Tokens) page.
    * **Database Name**—enter the Connection Name of the Connect AI data source you want to connect to (for example, *Salesforce1*).
    * **Connection Type**—select *Data Import*.

    <Frame>
      <img alt="Zoho Analytics Connection" />
    </Frame>
  </Step>

  <Step>
    Click **Next** to test and create your connection.
  </Step>

  <Step>
    Continue through each step of the connection dialog to import your data as needed.
  </Step>
</Steps>

When the data import process finishes, your data will be available to use in Zoho Analytics.

<Note>
  If your table contains underscores, such as `account_move`, you need to first create a derived view for that table without an underscore in the name. Then load the derived view instead. Zoho Analytics cannot load tables whose names include underscores.
</Note>


# iPaaS Tools
Source: https://docs.cloud.cdata.com/en/Clients/iPaaSTools

Below is a list of the Integration Platform as a Service (iPaaS) tools that connect to Connect AI:

* [Jitterbit](/en/Clients/Jitterbit-Client)
* [MuleSoft](/en/Clients/Mulesoft-Client)
* [SnapLogic](/en/Clients/SnapLogic-Client)


# Context Editor
Source: https://docs.cloud.cdata.com/en/Context-Editor

Improve query accuracy and reply times, and save tokens by providing business terms, dataset definitions, and column mappings that the MCP server uses to interpret your prompts.

<Note>The Context Editor is currently in beta as part of an early access program. More information about joining the program is available on the [CData AI page](https://www.cdata.com/ai).</Note>

The Context Editor gives AI models the business knowledge they need to translate natural language prompts into accurate data queries. You can import context from an existing resource (add external context), or create context manually using the built-in editor (add new context).

The left pane of the **Context Editor** page (in list view) contains **User Context** and **Global Context**.

## User Context

User context is the information about yourself that Connect AI sends to the AI automatically: once at the beginning of each conversation when you use the LLM Gateway, and together with the results of the `search_context` tool when you use the MCP server. You can add information such as your role, what kind of answers you prefer, and your time zone. The editor supports Markdown. You can add or edit information on this page or in the **User Context** tab of **Settings**.

## Global Context

Global context manages what AI agents know about your data.

### List View

Click **Global Context** and the list view icon to view a list of all the entities in your account and the number of named contexts assigned to them. The named contexts directly under **Global Context** apply to all connections and datasets, and you can have many of them. Use the search bar to find an entity. Expand an entity in the left pane to view the named contexts assigned to it. Click **+ Add Context** to add a new context or a new external context.

### Graph View

Click **Global Context** and the graph view icon to view a context graph of all the context entities and how they relate to each other across the semantic layer. Use the search bar to find an entity in the graph.

<Frame>
  <img alt="Context graph showing context editor entities and their relationships across the semantic layer" />
</Frame>

The context graph contains the following entity types:

* **Global Context**: The account-level context that applies to all connections and datasets. Use Global Context to define terms and rules that span your entire data environment.
* **Connection**: A named data source (for example, *MailChimp* or *PostgreSQL*). Context defined at the connection level applies to all datasets within that connection.
* **Dataset**: A table or query within a connection. Dataset-level context provides field-specific details to help the MCP server interpret queries against that dataset.
* **Metric**: A reusable measure defined on one or more fields. Metrics are created by importing a dbt semantic layer or a Snowflake semantic view.
* **Glossary**: Business terms, rules, and other business knowledge, optionally linked to columns. Glossary entries let the MCP server recognize business language. For example, map *Revenue* to the `total_sales` column so that prompts return accurate results.

### View Context Details

In list view or graph view, click an entity to view details about the entity.

<Frame>
  <img alt="Context details panel for a selected entity" />
</Frame>

## Add Context

There are two ways to add context:

* **Options menu**: Click the options menu (⋮) to the right of an entity to add context directly to that entity.
* **Add Context button**: Click **Add Context** to add context. You must select the entity type to apply it to: a specific connection or global context that applies to all connections and datasets.

You can import context from a dbt or Power BI file, or generate context using AI. You can also add new context manually by editing a context template.

### Add External Context

Use Add External Context to add semantic context globally or to a connection. The connection appears as the parent, with an expandable list of its datasets below it.

<Steps>
  <Step>
    Click **+ Add Context > Add External Context**. A dialog appears.
  </Step>

  <Step>
    In **Step 1** of the dialog, select a resource from the list of connections, or select **Global Context** to apply the context to all connections and datasets. Use the search bar to narrow down your search.
  </Step>

  <Step>
    Click **Next**.
  </Step>

  <Step>
    In **Step 2** of the dialog, select the **Source** of the semantic context: **dbt** or **Power BI**. Alternatively, you can have Connect AI generate context using AI.

    * For **dbt**, paste the contents of `manifest.json` in the space below.
    * For **Power BI**, select the Power BI (.pbix) file containing the semantic context.
      <Note>Snowflake connection context has an additional option: a **Snowflake Semantic View** YAML file.</Note>
    * For **Generate Context**, under **Tables** select **Generate context from all tables** or **Generate context from selected tables**. With selected tables, pick the tables in the list that appears. Toggle **Include Sample Values** on to improve accuracy, then click **Generate**. Sample values are available only when they are allowed in **Settings > Security** and the account has no HIPAA BAA; when the toggle is on, sample rows from the selected tables are sent to the LLM.

      **Generate Context** requires an authenticated connection, because it reads the tables through that connection. For a connection where each user signs in with their own credentials, the user generating context must have authenticated it themselves.

      You can close this dialog and Connect AI continues to generate context in the background.

      <Note>Generated context cannot be used on global context, only connection context.</Note>
  </Step>

  <Step>
    Click **Add** to add the context, or click **Generate** to generate context. The new context appears in the list under the resource you selected in Step 1: under Global Context, or under the connection with its datasets listed below it.
  </Step>
</Steps>

### Add New Context

To add a new context document manually to Global Context or to a connection, do the following:

<Steps>
  <Step>
    Click **+ Add Context > Add New Context**. A dialog appears.
  </Step>

  <Step>
    In **Step 1** of the dialog, select a resource from the list of connections, or select **Global Context** to apply the context to all connections and datasets. Use the search bar to narrow down your search.
  </Step>

  <Step>
    Click **Next**.
  </Step>

  <Step>
    In **Step 2** of the dialog, enter a name for the new context.
  </Step>

  <Step>
    Click **Add**.
  </Step>

  <Step>
    Edit the context template to define terms, relationships, or business rules that help the MCP server interpret your prompts accurately. See [Example: Jira Issues Dataset](#example-jira-issues-dataset) for a completed template.
  </Step>

  <Step>
    Click **Save**.
  </Step>
</Steps>

### Example: Jira Issues Dataset

The context template uses the following fields:

* **type**–The kind of concept, which can be `dataset` (a table or view), `metric` (a measure), or `glossary` (a business term or rule). All context created in the editor (not imported) is saved as `type: glossary`.
* **title**–The name of the concept as it appears in the context graph.
* **semanticType**–Your own sub-classification, in free text (for example, `fact_table`, `dimension`, or `kpi`). Connect AI stores it with the concept but does not use it for grouping or matching.
* **synonyms**–Other names users might type when asking about this concept. Include the words your users actually use.

In the body of the template:

* **Heading and Description**–Tell the MCP server what the concept covers and when it is relevant.
* **Related**–Other concepts this one depends on or explains.
* **Columns** (datasets only)–The fields that carry meaning, with descriptions. Remove this section for a glossary term or metric.

The following example shows a completed context file for a Jira Issues dataset.

```text wrap theme={null}
---
type: dataset
title: Jira Issues
semanticType: fact_table
synonyms:
  - tickets
  - tasks
  - bugs
  - stories
---

# Jira Issues

Contains all issues tracked in Jira, including bugs, tasks, stories, and epics.
Use this dataset to query issue status, assignments, priorities, and project breakdowns.

## Related

- Jira Projects
- Jira Users

## Columns

- **issue_key**—unique identifier for the issue (for example, PROJ-123)
- **summary**—short description of the issue
- **status**—current workflow state (for example, *To Do*, *In Progress*, *Done*)
- **assignee**—the user assigned to the issue
- **priority**—severity level (for example, *High*, *Medium*, *Low*)
- **project**—the Jira project the issue belongs to
- **issue_type**—category of issue (for example, *Bug*, *Story*, *Epic*, *Task*)
```

## Delete Context

To delete a context document:

<Steps>
  <Step>
    Click the delete icon next to the individual concept. To delete all concepts for a connection, click the options menu (⋮) to the right of the connection and click **Delete**.
  </Step>

  <Step>
    In the confirmation dialog, click **Delete**. When you delete all context for a connection, the button is **Delete all**; the connection itself is not deleted. Deleting context cannot be undone.
  </Step>
</Steps>


# Google Workspace SSO Troubleshooting
Source: https://docs.cloud.cdata.com/en/GoogleWorkspaceTroubleshooting

Common questions and issues when configuring Google Workspace as your SSO provider for Connect AI, with suggested solutions.

<Note>
  Connect AI uses Auth0 as its managed identity broker. You configure the SAML app, attribute mappings, and access in the Google Admin console; steps that refer to the Auth0 tenant, the connection's certificate, or Rules and Actions are configured by CData on the broker side. If one applies to your issue, contact [CData Support](https://www.cdata.com/support/submit.aspx).
</Note>

## Common Errors

<AccordionGroup>
  <Accordion title="No email or NameID is found in the assertion.">
    * In Google, set the Name ID to the user's Primary email.
    * Review the attribute mappings so that email and given\_name are sent and named as the broker expects.
  </Accordion>

  <Accordion title="The certificate is rejected or invalid.">
    Make sure Google's X.509 certificate was copied in full, including the header and footer lines:

    ```
    -----BEGIN CERTIFICATE-----
    The body of the certificate
    -----END CERTIFICATE-----
    ```

    Uploading Google's metadata XML instead, when that option is offered, avoids copy-and-paste mistakes. Because the certificate is held on the broker side, contact [CData Support](https://www.cdata.com/support/submit.aspx) if it needs to be replaced.
  </Accordion>

  <Accordion title="Users cannot open the app.">
    In the Google Admin console, confirm the SAML app is turned on for the users or organizational units that need access.
  </Accordion>

  <Accordion title="The redirect fails after sign-in.">
    * Confirm the ACS URL set in Google matches the callback URL exactly. It follows this pattern, where the tenant and connection name are the values CData provides when SSO is enabled: `https://<AUTH0-TENANT>.auth0.com/login/callback?connection=<CONNECTION_NAME>`
    * Check that the Entity ID in Google matches the value the broker expects.

    If you do not have the exact values, contact [CData Support](https://www.cdata.com/support/submit.aspx).
  </Accordion>
</AccordionGroup>

To enable SSO for your account or for additional help, contact [CData Support](https://www.cdata.com/support/submit.aspx).


# Anthropic SDK
Source: https://docs.cloud.cdata.com/en/LLM-Clients/Anthropic-SDK-LLMClient

The Anthropic SDK provides an interface for interacting with Claude models from Python and JavaScript applications. Follow the directions below to route requests through the Connect AI LLM Gateway.

## Prerequisites

Before you can configure the Anthropic SDK to use the Connect AI LLM Gateway, you must register a provider, create a routing rule, create a project, and issue a virtual key. See [LLM Gateway](/en/LLM-Gateway/LLM-Gateway) for details.

<Note>A Connect AI Personal Access Token (PAT) is not accepted by the LLM Gateway. Only a virtual key authenticates requests.</Note>

## Install the SDK

<Tabs>
  <Tab title="Python">
    ```bash theme={null}
    pip install anthropic
    ```
  </Tab>

  <Tab title="JavaScript">
    ```bash theme={null}
    npm install @anthropic-ai/sdk
    ```
  </Tab>
</Tabs>

## Send a Request

Set `base_url` (Python) or `baseURL` (JavaScript) to the Connect AI LLM Gateway endpoint and pass your virtual key as `api_key` or `apiKey`. The gateway selects the provider and model based on your project's routing rule.

<Tabs>
  <Tab title="Python">
    ```python theme={null}
    import anthropic

    client = anthropic.Anthropic(
        base_url="https://cloud.cdata.com/gateway/v1",
        api_key="<your-virtual-key>",
    )

    message = client.messages.create(
        max_tokens=1024,
        messages=[{"role": "user", "content": "Hello"}],
    )
    print(message.content)
    ```
  </Tab>

  <Tab title="JavaScript">
    ```typescript theme={null}
    import Anthropic from "@anthropic-ai/sdk";

    const client = new Anthropic({
      baseURL: "https://cloud.cdata.com/gateway/v1",
      apiKey: "<your-virtual-key>",
    });

    const message = await client.messages.create({
      max_tokens: 1024,
      messages: [{ role: "user", content: "Hello" }],
    });

    console.log(message.content);
    ```
  </Tab>
</Tabs>

## Configure with Environment Variables

As an alternative to passing connection details in code, you can set environment variables. The Anthropic SDK reads these automatically.

<Tabs>
  <Tab title="macOS / Linux">
    ```bash theme={null}
    export ANTHROPIC_BASE_URL="https://cloud.cdata.com/gateway/v1"
    export ANTHROPIC_API_KEY="<your-virtual-key>"
    ```
  </Tab>

  <Tab title="Windows (PowerShell)">
    ```powershell theme={null}
    $env:ANTHROPIC_BASE_URL = "https://cloud.cdata.com/gateway/v1"
    $env:ANTHROPIC_API_KEY = "<your-virtual-key>"
    ```
  </Tab>
</Tabs>

With environment variables set, you can instantiate the client without explicit arguments:

<Tabs>
  <Tab title="Python">
    ```python theme={null}
    import anthropic

    client = anthropic.Anthropic()  # reads ANTHROPIC_BASE_URL and ANTHROPIC_API_KEY from env

    message = client.messages.create(
        max_tokens=1024,
        messages=[{"role": "user", "content": "Hello"}],
    )
    print(message.content)
    ```
  </Tab>

  <Tab title="JavaScript">
    ```typescript theme={null}
    import Anthropic from "@anthropic-ai/sdk";

    const client = new Anthropic(); // reads ANTHROPIC_BASE_URL and ANTHROPIC_API_KEY from env

    const message = await client.messages.create({
      max_tokens: 1024,
      messages: [{ role: "user", content: "Hello" }],
    });

    console.log(message.content);
    ```
  </Tab>
</Tabs>


# Claude Code
Source: https://docs.cloud.cdata.com/en/LLM-Clients/ClaudeCode-LLMClient

Claude Code is Anthropic's agentic coding tool that reads your codebase, edits files, and runs commands from your terminal, IDE, desktop app, and browser. Follow the directions below to use Claude Code as the LLM engine in your own applications.

## Prerequisites

Before you can configure Claude Code to use the Connect AI LLM Gateway, you must register a provider, create a routing rule, create a project, and issue a virtual key in Connect AI. See [LLM Gateway](/en/LLM-Gateway/LLM-Gateway) for details.

<Note>A Connect AI Personal Access Token (PAT) is not accepted by the LLM Gateway. Only a virtual key authenticates requests.</Note>

## Configure Claude Code

Set the following environment variables to point Claude Code at the Connect AI LLM Gateway. The gateway selects the provider and model based on your project's routing rule.

<Tabs>
  <Tab title="macOS / Linux">
    ```bash theme={null}
    export ANTHROPIC_BASE_URL="https://cloud.cdata.com/gateway/v1"
    export ANTHROPIC_API_KEY="<your-virtual-key>"
    ```
  </Tab>

  <Tab title="Windows (PowerShell)">
    ```powershell theme={null}
    $env:ANTHROPIC_BASE_URL = "https://cloud.cdata.com/gateway/v1"
    $env:ANTHROPIC_API_KEY = "<your-virtual-key>"
    ```
  </Tab>
</Tabs>

## Start a Session

With the environment variables set, start Claude Code:

```bash theme={null}
claude
```


# Claude Desktop
Source: https://docs.cloud.cdata.com/en/LLM-Clients/ClaudeDesktop-LLMClient

Claude Desktop is Anthropic's desktop application for Claude. Follow the directions below to route Claude Desktop traffic through the Connect AI LLM Gateway.

## Prerequisites

Before you can configure Claude Desktop to use the Connect AI LLM Gateway, you must register a provider, create a routing rule, create a project, and issue a virtual key. See [LLM Gateway](/en/LLM-Gateway/LLM-Gateway) for details.

<Note>A Connect AI Personal Access Token (PAT) is not accepted by the LLM Gateway. Only a virtual key authenticates requests.</Note>

## Configure Claude Desktop

<Steps>
  <Step>
    Open Claude Desktop.
  </Step>

  <Step>
    In the application menu, enable **Developer Mode** by selecting **Help** > **Troubleshooting** > **Enable Developer Mode** (Windows and macOS).
  </Step>

  <Step>
    Quit and relaunch Claude Desktop.
  </Step>

  <Step>
    In the menu bar, select **Developer** > **Configure Third Party Inference** > **Gateway**.
  </Step>

  <Step>
    Select **Gateway** for where Claude Desktop sends inference requests.
  </Step>

  <Step>
    Configure the gateway connection as follows:

    * **Credential kind**—**Static API key**.
    * **Gateway base URL**—*[https://cloud.cdata.com/gateway/v1](https://cloud.cdata.com/gateway/v1)*.
    * **Gateway API key**—Your virtual key obtained from the Connect AI LLM Gateway.
  </Step>

  <Step>
    Click **Apply Changes**, then click **Save & Restart**.
  </Step>
</Steps>

Claude Desktop routes all requests through the Connect AI LLM Gateway. The gateway selects the provider and model based on your project's routing rule.


# Cursor
Source: https://docs.cloud.cdata.com/en/LLM-Clients/Cursor-LLMClient

Cursor is an AI-powered integrated development environment (IDE) developed by Anysphere. Follow the directions below to route Cursor traffic through the Connect AI LLM Gateway.

## Prerequisites

Before you can configure Cursor to use the Connect AI LLM Gateway, you must register a provider, create a routing rule, create a project, and issue a virtual key. See [LLM Gateway](/en/LLM-Gateway/LLM-Gateway) for details.

<Note>A Connect AI Personal Access Token (PAT) is not accepted by the LLM Gateway. Only a virtual key authenticates requests.</Note>

## Configure Cursor

<Steps>
  <Step>
    Open Cursor and go to **Cursor Settings** > **Models**.
  </Step>

  <Step>
    Scroll down to the bottom and expand **API Keys**.
  </Step>

  <Step>
    In **OpenAI API Key**, enter your virtual key obtained from the Connect AI LLM Gateway.
  </Step>

  <Step>
    Enable **Override OpenAI Base URL**.
  </Step>

  <Step>
    Enter the new OpenAI Base URL—*[https://cloud.cdata.com/gateway/v1](https://cloud.cdata.com/gateway/v1)*.
  </Step>

  <Step>
    Close **Cursor Settings**. Changes take effect immediately.
  </Step>
</Steps>

Cursor routes all requests through the Connect AI LLM Gateway. The gateway selects the provider and model based on your project's routing rule.


# OpenAI SDK
Source: https://docs.cloud.cdata.com/en/LLM-Clients/OpenAI-SDK-LLMClient

The OpenAI SDK provides an interface for interacting with OpenAI-compatible endpoints from Python and JavaScript applications. Follow the directions below to route requests through the Connect AI LLM Gateway.

## Prerequisites

Before you can configure the OpenAI SDK to use the Connect AI LLM Gateway, you must register a provider, create a routing rule, create a project, and issue a virtual key. See [LLM Gateway](/en/LLM-Gateway/LLM-Gateway) for details.

<Note>A Connect AI Personal Access Token (PAT) is not accepted by the LLM Gateway. Only a virtual key authenticates requests.</Note>

## Install the SDK

<Tabs>
  <Tab title="Python">
    ```bash theme={null}
    pip install openai
    ```
  </Tab>

  <Tab title="JavaScript">
    ```bash theme={null}
    npm install openai
    ```
  </Tab>
</Tabs>

## Send a Request

Set `base_url` (Python) or `baseURL` (JavaScript) to the Connect AI LLM Gateway endpoint and pass your virtual key as `api_key` or `apiKey`. The gateway selects the provider and model based on your project's routing rule.

<Tabs>
  <Tab title="Python">
    ```python theme={null}
    from openai import OpenAI

    client = OpenAI(
        base_url="https://cloud.cdata.com/gateway/v1",
        api_key="<your-virtual-key>",
    )

    response = client.chat.completions.create(
        messages=[{"role": "user", "content": "Hello"}],
    )
    print(response.choices[0].message.content)
    ```
  </Tab>

  <Tab title="JavaScript">
    ```typescript theme={null}
    import OpenAI from "openai";

    const client = new OpenAI({
      baseURL: "https://cloud.cdata.com/gateway/v1",
      apiKey: "<your-virtual-key>",
    });

    const response = await client.chat.completions.create({
      messages: [{ role: "user", content: "Hello" }],
    });

    console.log(response.choices[0].message.content);
    ```
  </Tab>
</Tabs>

## Configure with Environment Variables

As an alternative to passing connection details in code, you can set environment variables. The OpenAI SDK reads these automatically.

<Tabs>
  <Tab title="macOS / Linux">
    ```bash theme={null}
    export OPENAI_BASE_URL="https://cloud.cdata.com/gateway/v1"
    export OPENAI_API_KEY="<your-virtual-key>"
    ```
  </Tab>

  <Tab title="Windows (PowerShell)">
    ```powershell theme={null}
    $env:OPENAI_BASE_URL = "https://cloud.cdata.com/gateway/v1"
    $env:OPENAI_API_KEY = "<your-virtual-key>"
    ```
  </Tab>
</Tabs>

With environment variables set, you can instantiate the client without explicit arguments:

<Tabs>
  <Tab title="Python">
    ```python theme={null}
    from openai import OpenAI

    client = OpenAI()  # reads OPENAI_BASE_URL and OPENAI_API_KEY from env

    response = client.chat.completions.create(
        messages=[{"role": "user", "content": "Hello"}],
    )
    print(response.choices[0].message.content)
    ```
  </Tab>

  <Tab title="JavaScript">
    ```typescript theme={null}
    import OpenAI from "openai";

    const client = new OpenAI(); // reads OPENAI_BASE_URL and OPENAI_API_KEY from env

    const response = await client.chat.completions.create({
      messages: [{ role: "user", content: "Hello" }],
    });

    console.log(response.choices[0].message.content);
    ```
  </Tab>
</Tabs>


# LLM Gateway
Source: https://docs.cloud.cdata.com/en/LLM-Gateway/LLM-Gateway

LLM Gateway is a centrally managed proxy that routes LLM traffic to external providers through a single unified endpoint.

<Note>The LLM Gateway is currently in beta as part of an early access program. More information around joining the program can be found [here](https://www.cdata.com/ai).</Note>

***LLM Gateway*** is a centrally managed proxy that routes LLM requests from your applications and AI agents to external providers. Instead of each application holding its own provider API keys, the CData administrator registers providers once and governs all traffic through a single endpoint. Send requests to `https://cloud.cdata.com/gateway/v1` and Connect AI forwards them to the configured provider. Authenticate using the virtual key you issue on the **Virtual Keys** tab. Your application never holds a raw provider API key.

<Note>The LLM Gateway supports the following external providers: Anthropic, Azure OpenAI, Cohere, Custom OpenAI-compatible providers, Google Gemini, and OpenAI.</Note>

The **LLM Gateway** page contains the following tabs:

* [**Projects**](/en/LLM-Gateway/Projects): Contains a list of projects, each scoped to a routing rule and identified by a user-defined name.
* [**Virtual Keys**](/en/LLM-Gateway/Virtual-Keys): Contains a list of virtual keys for authentication. Virtual keys are the credentials a client sends to the LLM Gateway.
* [**Routing Rules**](/en/LLM-Gateway/Routing-Rules): Contains a list of routing rules that determine where a project's traffic goes: to a single provider, a priority-failover chain, or based on a model allowlist.

## Get Started Using LLM Gateway

The following is an overview of setting up the LLM Gateway. Refer to the linked sections for details.

<Note>You must be have a system role of Administrator to perform these tasks.</Note>

<Steps>
  <Step>
    **Register a provider.** On the [**LLM Providers**](/en/LLM-Gateway/LLM-Providers) page, click **+ Add Provider** and enter your provider name, type, and API key. This is the credential Connect AI uses to forward requests to the LLM provider. Next, select which of the provider's models to use (such as *claude-sonnet-5* for Anthropic or *gpt-4o* for OpenAI).
  </Step>

  <Step>
    **Create a routing rule.** On the [**Routing Rules**](/en/LLM-Gateway/Routing-Rules) tab of the **LLM Gateway** page, click **+ Add Routing Rule** and select a routing name, description, and type. Select **Single provider** to route all traffic to one provider, **Priority Failover** to route to a primary provider with automatic failover, or **Model Allowlist** to approve specific model–provider pairs. With **Model Allowlist**, the client names the model in each request, and the gateway forwards it to the paired provider or refuses it if the model is not on the list. Then configure the targets for your routing rule. If the organization-level default routing rule already suits your needs, you can skip this step and assign it when creating your project.
  </Step>

  <Step>
    **Create a project.** On the [**Projects**](/en/LLM-Gateway/Projects) tab of the **LLM Gateway** page, click **+ Add Project** and follow the instructions for creating a project. Add a project name and description, and then assign the routing rule you created in the previous step, or use the default routing rule. Save the project.
  </Step>

  <Step>
    **Issue a virtual key for the project.** On the **Virtual Keys** tab of your project, or on the [**Virtual Keys**](/en/LLM-Gateway/Virtual-Keys) tab of the main **LLM Gateway** page, click **+ Issue Virtual Key** and follow the instructions for issuing a virtual key.
  </Step>

  <Step>
    **Send requests through the gateway.** Point your LLM client at the Base URL for your LLM and authenticate with the virtual key, as follows:

    <Steps>
      <Step>
        **Choose your Base URL.** On the **Projects** tab of the **LLM Gateway** page, click **View Endpoints** to open a dialog showing the Gateway URL: `https://cloud.cdata.com/gateway/v1`.

        This URL is already complete. Do not add a suffix.
      </Step>

      <Step>
        **Configure your client.** Set your client's **Base URL** to the endpoint you copied. Pass the virtual key as the `Authorization: Bearer <virtual-key>` header or as the `x-api-key` header. The gateway selects the provider and model based on the project's routing rule.
        <Note>A Connect AI Personal Access Token is not accepted here; only the virtual key binds a request to its project.</Note>
      </Step>

      <Step>
        **Make a test request.** The following examples show a minimal request using different SDKs against the same base URL. Replace `<virtual-key>` with the key you issued.

        <CodeGroup>
          ```bash OpenAI-compatible (curl) theme={null}
          curl https://cloud.cdata.com/gateway/v1/chat/completions \
            -H "Authorization: Bearer <virtual-key>" \
            -H "Content-Type: application/json" \
            -d '{
              "messages": [{"role": "user", "content": "Hello"}]
            }'
          ```

          ```python OpenAI SDK (Python) theme={null}
          from openai import OpenAI

          client = OpenAI(
              base_url="https://cloud.cdata.com/gateway/v1",
              api_key="<virtual-key>",
          )

          response = client.chat.completions.create(
              messages=[{"role": "user", "content": "Hello"}],
          )
          print(response.choices[0].message.content)
          ```

          ```python Anthropic SDK (Python) theme={null}
          import anthropic

          client = anthropic.Anthropic(
              base_url="https://cloud.cdata.com/gateway/v1",
              api_key="<virtual-key>",
          )

          message = client.messages.create(
              max_tokens=1024,
              messages=[{"role": "user", "content": "Hello"}],
          )
          print(message.content)
          ```
        </CodeGroup>
      </Step>
    </Steps>
  </Step>
</Steps>


# LLM Providers
Source: https://docs.cloud.cdata.com/en/LLM-Gateway/LLM-Providers

Register and manage LLM provider credentials for the LLM Gateway.

The ***LLM Providers*** page contains a list of available LLM providers, models, and the API keys the gateway uses to reach them. LLM Gateway supports the following external providers: Anthropic, Azure OpenAI, Cohere, Custom OpenAI-compatible providers, Google Gemini, and OpenAI.

<Frame>
  <img alt="LLM Gateway Providers" />
</Frame>

Each provider displays the following information:

* **Provider**—the user-friendly name and type of the LLM provider.
* **Models**—the LLM you are using (for example, *gpt-4o* or *claude-sonnet-5*).
* **Status**—the status of the LLM provider: **Active** or **Inactive**.
* **API Key**—a masked representation of the API key obtained from the LLM provider. The API key cannot be edited after the provider is registered. To update an API key, delete the provider and re-add it.

Each provider also contains edit and delete icons. On the edit page of the provider, you can edit the provider's **Name** and add or delete **Models**. Click **Save Changes** when finished. Click the delete icon to remove the provider.

<Note>You must be have a system role of Administrator to add, edit, or delete providers. Non-administrators can view this page but cannot make any changes.</Note>

## Add a Provider

<Note>For each provider, obtain your API key from that provider's developer console before registering.</Note>

To register a new LLM provider, do the following:

<Steps>
  <Step>
    Click **+ Add Provider**. An **Add LLM Provider** dialog appears.
  </Step>

  <Step>
    Enter the following information about the provider (Step 1):

    * **Name**—enter a friendly name for the provider.
    * **Provider**—select a supported provider type.
    * **Base URL**—(Azure OpenAI only) enter the base endpoint for the provider, for example, *[https://my-endpoint.example.com/v1](https://my-endpoint.example.com/v1)*.
    * **API Key**—enter the provider's API key.
  </Step>

  <Step>
    Add the LLM models to use for the provider (Step 2). Click **+ Add Model** and enter the model name. Repeat to add additional models.
  </Step>

  <Step>
    When you are finished adding models, click **Add**. The LLM provider appears on the **LLM Providers** page with a status of **Active**.
  </Step>
</Steps>


# Projects
Source: https://docs.cloud.cdata.com/en/LLM-Gateway/Projects

Projects route LLM traffic according to an assigned routing rule.

A project is a named routing context that groups related LLM traffic together and assigns it a routing rule. It routes traffic to a specific provider (or failover chain) based on its assigned routing rule. Projects allow different teams or workloads to use different providers without interfering with one another.

The **Projects** tab of the **LLM Gateway** page contains a list of LLM Gateway projects.

<Frame>
  <img alt="LLM Gateway projects" />
</Frame>

Each project displays the following information:

* **Name**–the user-defined name of the project.
* **Routing Rule**–the routing rule for the project. Routing rules are set up on the [**Routing Rules**](/en/LLM-Gateway/Routing-Rules) page.

- **Status**–the status of the project: **Active** or **Inactive**. Active projects receive routed traffic.
- **Monthly Spend**–the monthly spend allotted to the project, along with the amount spent this month. For example, **\$100 / \$700** means \$100 of the \$700 monthly budget has been spent.

Click the project's edit icon to view details about each project, including its routing rule and virtual keys. You can edit the **Name**, **Description**, and **Routing Rule**. You can also issue, rotate, and delete virtual keys for the project. Click the delete icon to delete the project.

<Note>You must be have a system role of Administrator to add, edit, or delete projects. Non-administrators can view this page but cannot make any changes.</Note>

## Add a Project to the LLM Gateway

To add a project, do the following:

<Steps>
  <Step>
    Click **+ Add Project**. An **Add Project** dialog appears.
  </Step>

  <Step>
    In the **Details** tab of the dialog (Step 1), enter a **Name** and **Description** for the project. Click **Next**.
  </Step>

  <Step>
    In the **Routing Rule** tab of the dialog (Step 2), select an **Existing Routing Rule** or **Create a New Routing Rule**. See [**Routing Rules**](/en/LLM-Gateway/Routing-Rules) for more information on creating routing rules. Click **Next**.
  </Step>

  <Step>
    In the **Limits** tab of the dialog (Step 4), add the following:

    **Spend Limits** section:

    * **Budget**—enter the monthly budget for this project, or select **Unlimited**. If you select **Unlimited**, the remaining Spend Limits fields are hidden.
    * **Limit Type**—toggle **Hard Limit** or **Soft Limit**. A hard limit stops requests after the budgeted amount. A soft limit sends a notification that the limit was reached, but allows requests to go through.
    * **Notification Threshold**—set a threshold level, such as 75% of budget, for sending a notification (required for soft limit).
    * **Notification Frequency**—select **Once** or **Hourly** for sending threshold notifications.

    **Rate Limits** section:
    Select **Unlimited** to apply no rate limits. Otherwise, enter the following:

    * **Request Limit**—enter the maximum number of requests and select the time period: minutes, hours, or days.
    * **Token Limit**—enter the maximum number of tokens and select the time period: minutes, hours, or days.
  </Step>

  <Step>
    Click **Add** to add the project. The new project's summary appears on the project's details page.
  </Step>

  <Step>
    You can issue a virtual key for the project or return to it later. See [**Virtual Keys**](/en/LLM-Gateway/Virtual-Keys) for details.
  </Step>

  <Step>
    Make any other changes to the project and click **Save Changes**. The new project appears on the **Projects** tab with a default status of **Active**.
  </Step>
</Steps>

## Edit a Project

To edit a project, do the following:

<Steps>
  <Step>
    On the **Projects** tab, click the edit icon for the project you want to edit. The project's details page appears.
  </Step>

  <Step>
    Edit the **Name** and **Description** as needed.
  </Step>

  <Step>
    In the **Routing Rule** tab, change the routing rule or the prompt enrichment settings. See [**Routing Rules**](/en/LLM-Gateway/Routing-Rules) for details.
  </Step>

  <Step>
    In the **Spend Limits** tab, edit the spend limits for the project. See [**Spend Limits**](#spend-limits) for field descriptions.
  </Step>

  <Step>
    In the **Rate Limits** tab, edit the rate limits for the project. See [**Rate Limits**](#rate-limits) for field descriptions.
  </Step>

  <Step>
    To manage virtual keys for the project, see [**Virtual Keys**](/en/LLM-Gateway/Virtual-Keys).
  </Step>

  <Step>
    Click **Save Changes**.
  </Step>
</Steps>

## Spend Limits

The **Spend Limits** tab controls the monthly budget and notification settings for a project.

* **Budget**—enter the monthly budget for this project, or select **Unlimited**. If you select **Unlimited**, the remaining Spend Limits fields are hidden.
* **Limit Type**—toggle **Hard Limit** or **Soft Limit**. A hard limit stops requests after the budgeted amount. A soft limit sends a notification that the limit was reached, but allows requests to go through.
* **Notification Threshold**—set a threshold level, such as 75% of budget, for sending a notification (required for soft limit).
* **Notification Frequency**—select **Once** or **Hourly** for sending threshold notifications.

## Rate Limits

The **Rate Limits** tab controls the maximum number of requests and tokens for a project. Select **Unlimited** to apply no rate limits. Otherwise, enter the following:

* **Request Limit**—enter the maximum number of requests and select the time period: minutes, hours, or days.
* **Token Limit**—enter the maximum number of tokens and select the time period: minutes, hours, or days.


# Routing Rules
Source: https://docs.cloud.cdata.com/en/LLM-Gateway/Routing-Rules

Define how LLM requests are distributed across providers using single, priority failover, or model allowlist rules.

A routing rule determines which LLM provider handles traffic for a project and how Connect AI responds if a provider becomes unavailable. Each project is assigned one routing rule. Projects that do not specify a routing rule inherit the organization's default routing rule.

The **Routing Rules** tab lists all configured routing rules for your organization.

<Frame>
  <img alt="Routing Rules" />
</Frame>

Each routing rule contains the following information:

* **Name**—the name of the routing rule.
* **Rule Type**—the type of routing strategy: **Single**, **Priority Failover**, or **Model Allowlist**.
* **Projects**—the projects that use this rule.
* **Status**—the status of the routing rule: **Active** or **Inactive**.
* **Workspace Default**—indicates whether this routing rule is the organization's default. The default routing rule applies to projects that do not specify a routing rule.

Each routing rule also contains edit and delete icons. You can edit the routing rule **Name**, **Description**, **Rule Type**, and **Provider and Model**.

<Note>You must be have a system role of Administrator to add, edit, or delete routing rules. Non-administrators can view this page but cannot make any changes.</Note>

## Routing Rule Types

Connect AI supports the following routing rule types:

* **Single Provider**—routes all traffic to one provider and model. Use this when you do not require failover.
* **Priority Failover**—routes traffic to a primary provider and automatically fails over to the next provider in the configured chain if the primary provider becomes unavailable. Use this to improve reliability across multiple providers.
* **Model Allowlist**—routes each request to the provider paired with the model the client specified. If the requested model is not on the allowlist, the gateway refuses the request with an error. Use this when you want to approve specific models while letting the client choose among them.

## Add a Routing Rule

To add a new routing rule, do the following:

<Steps>
  <Step>
    Click **+ Add Routing Rule**. An **Add Routing Rule** dialog appears.
  </Step>

  <Step>
    Enter the following information about the routing rule:

    * **Name**—enter the name of the routing rule.
    * **Description**—(optional) enter a brief description of the routing rule.
    * **Use as default rule for Workspace**—toggle on to set this rule as the default. Projects that do not specify a routing rule use this default rule.
    * **Rule Type**—select the routing strategy from the drop-down list. Select **Single provider** if you have one provider. Select **Priority failover** to route traffic to providers in order, with automatic failover if a provider becomes unavailable. Select **Model Allowlist** to define a set of approved model–provider pairs; the client specifies the model in each request, and the gateway forwards it to the paired provider or refuses it if the model is not on the list.
    * **Provider and Model**—select the provider and model that you set up on the [**LLM Providers**](/en/LLM-Gateway/LLM-Providers) page.

    <Note>If you select **Priority failover**, click **+ Add Failover Provider and Model** after entering the primary provider and model. Enter the failover **Provider and Model #2**. Add more failover providers if needed.</Note>
    <Note>If you select **Model Allowlist**, click **+ Add Allowed Providers and Models** to add each approved model–provider pair. You can add up to 50 pairs. If the same model appears more than once, the first entry listed serves the request.</Note>
  </Step>

  <Step>
    Under **Prompt Enrichment**, toggle on **Global Context**, **User Context**, or both, if desired.

    * **Global Context**—the LLM Gateway searches your global context for the tables and columns that matter to the question being asked. See [**Context Editor**](/en/Context-Editor) for more information.
      <Note>Global context runs on every message, so it is the slowest context option.</Note>
    * **User Context**—the LLM Gateway uses your user notes shared under **Settings** > **User Context**. It is sent once at the beginning of the conversation. See [**User Context**](/en/Settings/User-Context) for more information.
  </Step>

  <Step>
    Under **CData MCP**, toggle on **Search Context Tool/Skill**, **Data Source Instructions**, or both, if desired. **Search Context Tool/Skill** tells the CData MCP to use the `search_context` tool and skills. **Data Source Instructions** tell the model how to query a particular data source. The data source instructions are found in the **AI Instructions** tab of the data source.
    <Note>To use either the search context tool or data source instructions, you must have the CData MCP server added to your agent. Both are sent once at the start of a conversation.</Note>
  </Step>

  <Step>
    Click **Add**. The new routing rule appears in the **Routing Rules** list.
  </Step>
</Steps>


# Virtual Keys
Source: https://docs.cloud.cdata.com/en/LLM-Gateway/Virtual-Keys

Virtual keys are the credentials a client sends to the LLM Gateway to authenticate.

After you create a project in the LLM Gateway, you issue a virtual key for the project. You can then send requests through the gateway by pointing your LLM client at the Base URL for your LLM and authenticating with the virtual key.

The **Virtual Keys** tab of the **LLM Gateway** page contains a list of virtual keys assigned to LLM Gateway projects.

<Frame>
  <img alt="LLM Gateway virtual keys" />
</Frame>

Each virtual key entry displays the following information:

* **Key**—the beginning of the virtual key. The full virtual key does not appear again after it is issued.
* **User**—the user or service account the key is issued to.
* **Projects**—the project the key is issued to.
* **Status**—the status of the project the virtual key is issued to: **Active** or **Inactive**.
* **Monthly Spend**—(coming soon) the monthly spend allotted to the project, along with the spend reset date.
* **Issued**—the date and time the virtual key was issued.

Click the rotate or delete icons to manage the virtual key for the project.

<Note>You must be have a system role of Administrator to issue or rotate virtual keys. Non-administrators can list or revoke their own virtual keys.</Note>

## Issue a Virtual Key

You can issue a virtual key from the main **LLM Gateway** page or within a project.

To issue a virtual key from the main **LLM Gateway** page, do the following:

<Steps>
  <Step>
    In the **Virtual Keys** tab, click **+ Issue Virtual Key**. An **Issue Virtual Key** dialog appears.
  </Step>

  <Step>
    Select the **User** and **Project** to issue the virtual key to.
  </Step>

  <Step>
    Click **Issue**.
  </Step>

  <Step>
    Copy the virtual key. The entire virtual key is only shown once, so save it before clicking **Close**.
  </Step>

  <Step>
    Part of the virtual key appears on the **Virtual Keys** tab of the **LLM Gateway** page. The default status of the virtual key is **Active**. You can rotate or revoke the virtual key by clicking the rotate or delete icons.
  </Step>
</Steps>

To issue a virtual key within a project, do the following:

<Steps>
  <Step>
    In the **Projects** tab, select the project to assign a virtual key to.
  </Step>

  <Step>
    In the lower part of the project page, click the **Virtual Keys** tab.

    <Frame>
      <img alt="LLM Gateway virtual keys" />
    </Frame>
  </Step>

  <Step>
    Click **+ Issue Virtual Key**. An **Issue Virtual Key** dialog appears.
  </Step>

  <Step>
    Select the **User** to issue the virtual key to. The **Project** is pre-selected and cannot be changed.
  </Step>

  <Step>
    Click **Issue**.
  </Step>

  <Step>
    Copy the virtual key. The entire virtual key is only shown once, so save it before clicking **Close**.
  </Step>

  <Step>
    Part of the virtual key appears in the **Virtual Keys** section of the project edit page. The default status of the virtual key is **Active**. You can rotate or revoke the virtual key by clicking the rotate or delete icons.
  </Step>
</Steps>


# MCP Gateway
Source: https://docs.cloud.cdata.com/en/MCP-Gateway

Configure and manage MCP tool servers for governed AI agent access.

The ***MCP Gateway*** page is where you configure the tool servers, or the MCP endpoints your agents connect to.

## Tool Servers

**Tool Servers** lists your tool servers and their agent URLs. Use the search bar to filter tool servers by name.

<Frame>
  <img alt="MCP Gateway Tool Servers" />
</Frame>

**Tool Servers** contains the following information about each tool server:

* **Name**—the user-defined name of the tool server.
* **MCP Servers**—icons representing the MCP servers your agent is connected to through the tool server.
* **Agent URL**—the endpoint URL your agents connect to, generated automatically when you create the tool server. Click the copy icon to copy the endpoint into your AI client.

Each row includes edit and delete icons. Selecting one or more rows with the checkboxes reveals a **Delete** button to remove them in bulk.

<Note>You must be have a system role of Administrator to add, modify, or delete a tool server. Non-administrators can view tool servers and connect to their own upstream accounts.</Note>

Tool servers that include 3rd party MCP servers also show a **How to Connect** link. Clicking it opens a dialog with instructions for connecting your agent to that tool server.

### Add a Tool Server

<Steps>
  <Step>
    Click **+ Add Tool Server**. An **Add Tool Server** dialog appears.
  </Step>

  <Step>
    In **Step 1: Details**, enter a **Name** for your tool server. Names must use lowercase letters, numbers, hyphens, and dots only. Click **Next**.
  </Step>

  <Step>
    In **Step 2: Select MCP Servers**, add the MCP servers to bundle in this tool server.

    The left pane summarizes the servers in this tool server: the number of CData Source MCPs selected and a list of any 3rd party MCP servers added. The right pane is the browse and configuration area.

    **CData Source MCPs**: In the right pane, browse or search for the data source MCPs available in your Connect AI workspace. Select the checkbox next to each source you want to include. Each entry shows the tool prefix applied to that source's tools (for example, *mailchimp2\_\**). The left pane updates to show the number of selected sources.

    **3rd Party MCP Servers** (optional): In the left pane, click **+ Add 3rd Party MCP Server**. An entry form appears on the right. Enter the following information:

    * **Name**—a name for this MCP server. The name is used as a prefix on this server's tool names to keep them distinct.
    * **Upstream MCP URL**—the endpoint of the upstream MCP server. Must be an HTTPS endpoint serving MCP over HTTP+SSE or Streamable HTTP.
    * **Authentication**—select the authentication type and follow the relevant instructions below.

    <Tabs>
      <Tab title="Per-user OAuth (automatic setup)">
        The upstream server uses OAuth with user consent. Connect AI handles the OAuth flow automatically. This authentication type requires no additional fields.
      </Tab>

      <Tab title="Per-user token">
        Each user provides their own token to authenticate with the upstream server. After the tool server is created, click **How to Connect** in the Tool Servers list to open a dialog where you can enter your token.
      </Tab>
    </Tabs>

    Click **+ Add 3rd Party MCP Server** again to add additional servers to this tool server.
  </Step>

  <Step>
    Click **Add**. The new tool server appears in the **Tool Servers** list with an automatically generated **Agent URL**.
  </Step>
</Steps>

<Note>
  **Step 3: Configure Tools** is coming soon. The tool server currently exposes every tool on every upstream server.
</Note>

## Connect to a Tool Server

Copy the **Agent URL** from the **Tool Servers** list and configure your AI client to use it as an MCP server.

If the tool server includes 3rd party MCP servers, click **How to Connect** to complete authentication. For **Per-user OAuth**, you are prompted to sign in to the upstream server in a browser. For **Per-user token**, enter your token in the dialog.


# Microsoft Entra ID SSO Troubleshooting
Source: https://docs.cloud.cdata.com/en/MicrosoftEntraIDTroubleshooting

Common questions and issues when configuring Microsoft Entra ID as your SSO provider for Connect AI, with suggested solutions.

<Note>
  Connect AI uses Auth0 as its managed identity broker. Any step that refers to the Auth0 tenant, domain, plan, or Rules and Actions is configured by CData on the broker side. If one applies to your issue, contact [CData Support](https://www.cdata.com/support/submit.aspx). The remaining steps are configured in your own identity provider.
</Note>

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="Which scopes should I request?">
    Use `openid email profile`. Only `openid` is mandatory; add others, like `offline_access`, solely when your scenario calls for refresh tokens.
  </Accordion>

  <Accordion title="Can we restrict who can log in?">
    Yes. On your side, enable **User assignment required** in Entra ID and assign only the intended users or groups. Additional filtering by email, domain, or group via Auth0 Actions or Rules is configured by CData on the broker side; contact [CData Support](https://www.cdata.com/support/submit.aspx) if you need it.
  </Accordion>
</AccordionGroup>

## Common Errors

<AccordionGroup>
  <Accordion title="The connection returns a non-specific error.">
    * A mismatched endpoint is the most likely cause. The common endpoint ([https://login.microsoftonline.com/common](https://login.microsoftonline.com/common)) only requires your email domain. A tenant-specific endpoint ([https://login.microsoftonline.com/companyname.com](https://login.microsoftonline.com/companyname.com)) additionally requires a client ID and client secret, so double-check that both are entered correctly.
    * Make sure the redirect URI registered in Entra ID exactly matches the broker's callback URL (ends in `/login/callback`). CData provides the exact value when SSO is enabled.
    * Confirm the tenant ID is correct in all URLs.
  </Accordion>

  <Accordion title="An 'option validation failed' error is returned.">
    A malformed URL is the usual cause. When you supply your Entra endpoints, use the v2.0 versions, with no trailing slashes and no query parameters such as `?scope=...` in the URL. The connection strategy itself (OIDC versus SAML) is selected by CData on the broker side, so if the URLs look correct, contact [CData Support](https://www.cdata.com/support/submit.aspx).
  </Accordion>

  <Accordion title="A 403 is returned or the connection fails to save.">
    Both common causes here are on the broker side that CData manages:

    * The connection may need to use the default Auth0 domain rather than a custom one.
    * The Auth0 plan must support Enterprise (SSO) connections.

    Contact [CData Support](https://www.cdata.com/support/submit.aspx) to check these.
  </Accordion>
</AccordionGroup>

To enable SSO for your account or for additional help, contact [CData Support](https://www.cdata.com/support/submit.aspx).


# Okta SSO Troubleshooting
Source: https://docs.cloud.cdata.com/en/OktaTroubleshooting

Common questions and issues when configuring Okta Workforce Identity Cloud as your SSO provider for Connect AI, with suggested solutions.

<Note>
  Connect AI uses Auth0 as its managed identity broker. Any step that refers to the Auth0 tenant, domain, plan, or Rules and Actions is configured by CData on the broker side and is not something you set up yourself. If one applies to your issue, contact [CData Support](https://www.cdata.com/support/submit.aspx). The remaining steps are configured in Okta.
</Note>

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="Which scopes should I request?">
    * Start with `openid email profile`.
    * Do not request additional scopes unless you have verified that your Okta application is configured to grant them.
  </Accordion>

  <Accordion title="Can I decide who is permitted to sign in?">
    Yes. On your side, limit the Okta application's assignment to the specific users or groups that need access. A second filter, screening logins by email domain, group, or other attributes via Auth0 rules, is configured by CData on the broker side; contact [CData Support](https://www.cdata.com/support/submit.aspx) if you need it.
  </Accordion>
</AccordionGroup>

## Common Errors

<AccordionGroup>
  <Accordion title="The test connection fails without a specific message.">
    * Make sure each URL references your own Okta domain and contains `/default` in its path.
    * Check that the redirect URI is an **exact** match for what is registered in Okta.
  </Accordion>

  <Accordion title="An 'option validation failed' error is returned.">
    Check for any of the following:

    * A missing or incorrect field, for example `issuer` or `client_id`.
    * A URL with a typo.
    * A reference to *[https://okta.com](https://okta.com)* instead of your own Okta tenant domain.
  </Accordion>

  <Accordion title="A 403 is returned or the connection refuses to save.">
    Both common causes here are on the broker side that CData manages:

    * The connection may need to use the default Auth0 domain rather than a custom one.
    * The Auth0 plan must support Enterprise (SSO) connections.

    Contact [CData Support](https://www.cdata.com/support/submit.aspx) to check these.
  </Accordion>
</AccordionGroup>

To enable SSO for your account or for additional help, contact [CData Support](https://www.cdata.com/support/submit.aspx).


# OpenID Connect SSO Troubleshooting
Source: https://docs.cloud.cdata.com/en/OpenIDConnectTroubleshooting

Common questions and issues when configuring OpenID Connect as your SSO provider for Connect AI, with suggested solutions.

<Note>
  Connect AI uses Auth0 as its managed identity broker. You configure the OIDC application, client credentials, and claims at your provider; steps that refer to the Auth0 tenant, the flow it uses, or Rules and Actions are configured by CData on the broker side. If one applies to your issue, contact [CData Support](https://www.cdata.com/support/submit.aspx).
</Note>

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="Can I use PKCE or a custom response type?">
    The broker signs users in with the authorization code flow by default. Alternative response types, such as `id_token token`, are not used in this flow.
  </Accordion>

  <Accordion title="Can I restrict access to certain users?">
    Yes. Filter access at your provider by domain, group, or email. The same can be done at the broker with Auth0 Rules or Actions, but that part is configured by CData; contact [CData Support](https://www.cdata.com/support/submit.aspx) if you need it.
  </Accordion>
</AccordionGroup>

## Common Errors

<AccordionGroup>
  <Accordion title="The test connection fails with 'invalid_client'.">
    * Verify the client ID and client secret are correct and still active.
    * Make sure the redirect URI registered at your provider matches the broker's callback URL exactly: `https://<YOUR-AUTH0-TENANT>.auth0.com/login/callback`
    * That callback URL has to be registered as an allowed redirect URI in your provider. If you do not have the exact value, contact [CData Support](https://www.cdata.com/support/submit.aspx).
  </Accordion>

  <Accordion title="An 'issuer mismatch' error appears or discovery fails.">
    * Confirm the issuer URL matches the `iss` value in the ID token exactly.
    * If your provider does not publish a discovery document, the individual endpoint URLs have to be entered manually. That is done on the broker side, so contact [CData Support](https://www.cdata.com/support/submit.aspx) with the endpoint details.
  </Accordion>

  <Accordion title="Expected claims such as email or profile are missing.">
    Check that your provider returns the standard OIDC claims, either in the ID token or from the userinfo endpoint. You may need to add the relevant scopes and claims to the application configuration at your provider.
  </Accordion>
</AccordionGroup>

To enable SSO for your account or for additional help, contact [CData Support](https://www.cdata.com/support/submit.aspx).


# Permissions and Access Control
Source: https://docs.cloud.cdata.com/en/Permissions

Access control in Connect AI is ensured using roles, permissions, and authentication patterns (shared or per-user authentication).

Connect AI’s data governance allows managing permissions in bulk by using Role-Based Access Control (RBAC). You can grant access to resources directly to individual users or through one or more roles that credentialed users belong to. Roles determine permissions (data and execution access to entities) and privileges (administrative tasks such as billing, settings, and user management).

You can further control how users connect to each data source by choosing an authentication pattern: either shared authentication, where all users access the data source using a single service account, or per-user authentication, where each user authenticates with their own credentials.

## Users

An Administrator or User Administrator invites new users via email. Users sign in to Connect AI with a username and password (or use their company’s SSO if enabled on the account). Administrators can then assign the appropriate role or roles to the new user.

If Just-in-Time (JIT) provisioning is enabled, a user account is created automatically the first time the user signs in through SSO, without a manual invitation. The new user receives a default Query system role and default connection and workspace permissions, which an Administrator or User Administrator can modify later. See [JIT User Provisioning](/en/SCIM/SSO) for details.

## Roles

A role is a collection of administrative privileges, as well as permissions to access resources. Roles adhere to the following guidelines:

* Any role can be assigned to any user.
* Every role has specific permissions.
* When a role is assigned to a user, the user gets all the permissions associated with that role. A user with multiple roles has all the permissions associated with each of them. Permissions are **additive**. A user’s access is the union of every permission from all their assigned roles, so the most permissive grant always applies. Roles never remove or override access granted by another role.

  For example, if a user has role\_1 and role\_2, with role\_1 having Select permission for a data connection and role\_2 having no access to the data connection, role\_1 takes precedence, and the user has access to the data connection.

Connect AI contains four predefined system roles: Administrator, Connection Administrator, User Administrator, and Query.

The following table defines the scope of each Connect AI system role.

| Role | Scope | Log Access |
| - | - | - |
| Administrator | Full account access: connections, users, billing, settings, LLM Gateway, MCP Gateway | All query logs and all audit events |
| Connection Administrator | Create/edit/delete connections and workspaces; manage jobs and data warehouse; assign connection & workspace permissions; view users read-only; query all connections | All query logs; connection-domain audit events only |
| User Administrator | Create/invite/edit/disable users; assign/revoke User Administrator and Query roles; view connections & workspaces read-only; query connections where explicitly granted | User-domain audit events only (invites, user creation, role changes, PAT activity, impersonation, login activity); user's own query logs only |
| Query | Query connections where granted permission; authenticate via User Credentials when configured | User's own query logs only; no audit log access |

See [Roles](/en/Roles) for more information.

## Permissions

Permissions are more granular levels of access that make up roles. You can assign the following entity permissions:

<Note>For the purposes of permissions, an *entity* is a data connection (for example, Salesforce1) or a workspace (for example, MyWorkspace). Entities are displayed with the connection logo, and workspaces are displayed with a folder icon.</Note>

* **Select:** The user can select rows from tables in an entity.
* **Insert:** The user can insert rows into tables of an entity.
* **Update:** The user can update rows in tables of an entity.
* **Delete:** The user can delete rows from tables in an entity.
* **Execute:** The user can execute stored procedures in an entity.

Connect AI offers two paths to assign these permissions: by user (one user across multiple entities) or by entity (one entity across multiple users).

### Assign Permissions by User

You can grant entity permissions on a per-user basis from the **Edit User** page, or to multiple users at once by defining an access role on the **Edit Role** page. The permissions coexist additively; that is, assigning a user to a role never removes a user's direct permissions.

<Frame>
  <img alt="Assign permissions by user" />
</Frame>

Click an individual box in the table to toggle a permission for a single entity, or click the box at the top of a table column to toggle that permission for every entity.

### Assign Permissions by Entity

You can also assign permissions on an entity basis via the **Edit/Add Connection** page or via the **Workspace** page. For example, in the **Permissions** tab of the **Edit Acumatica Connection** page, you can grant permissions on the connection to multiple users at once. All users can select data, but only three users can insert data:

<Frame>
  <img alt="Assign permissions by entity" />
</Frame>

Click an individual box in the table to toggle the permission for a single user, or click the box at the top of a table column to toggle that permission for all users.

### Workspace Access and Source Permissions

When a workspace contains an asset that originates from a source connection, access to that asset is governed by the workspace permission rather than the source connection permission. A user who has access to a workspace can access the assets in that workspace regardless of whether they have access to the underlying source connection (either through per-user permissions or through a role).

This workspace-scoped access applies even when the workspace is added to a toolkit and exposed to an AI through a custom MCP endpoint. In other words, if a user has been granted access to a workspace, they can access the assets in that workspace through the custom MCP endpoint even if they do not have access to the source connections those assets come from.

## Authentication Patterns

### Shared Authentication (Service Account)

By default, all users on an account can access data from a data source with shared authentication using a service account in the data source. Use shared authentication for read-only data sources that do not contain user-specific permissions or systems that lack per-user authentication.

For example, if you have a connection to Salesforce with shared authentication, all user accounts can access the data from the Salesforce account created for that Salesforce connection. Query permissions can be customized for each user to restrict available operations, but all users access the same data under these restrictions.

### Per-User Authentication

Certain data sources support the ability to force each user on an account to log in to a connection with their own login credentials. Use per-user authentication to comply with regulatory requirements or for data that varies by user. Per-user authentication ensures that users can only access the data from accounts that they need to access. Furthermore, when a connection is configured in this way, it only counts as a single connection slot toward your account maximum.

If a data source supports per-user authentication, an **Authentication Model** section appears under the **Authentication** section of the connection settings. Select either **Shared Authentication** or **Per-User Authentication**.

<Frame>
  <img alt="Authentication Model" />
</Frame>

If this feature is not available for a specific data source and you would like it, contact our support team to request the feature.

<Note>
  The following restrictions apply to this feature:

  * Only Administrators can toggle a data source between **Shared Authentication** and **Per-User Authentication**, but users of all roles can log in to a per-user authentication connection with their own credentials.
  * Per-user authentication is not supported when using the [OData API](/en/API/OData-Dashboard). To connect a data source to the OData API, you must use shared authentication.
  * Caching is permitted only with shared authentication, not per-user authentication. See [Caching](/en/Caching) for details.
</Note>


# PingFederate SSO Troubleshooting
Source: https://docs.cloud.cdata.com/en/PingFederateTroubleshooting

Common questions and issues when configuring PingFederate as your SSO provider for Connect AI, with suggested solutions.

<Note>
  Connect AI uses Auth0 as its managed identity broker. Any step that refers to the Auth0 tenant, domain, plan, or Rules and Actions is configured by CData on the broker side and is not something you set up yourself. If one applies to your issue, contact [CData Support](https://www.cdata.com/support/submit.aspx). The remaining steps are configured in PingFederate.
</Note>

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="Can I restrict who is allowed to sign in?">
    Yes. On your side, constrain access in PingFederate using access control policies or attribute filters keyed to roles or group membership. Additional control can be layered on in Auth0 with Rules or Actions, but that part is configured by CData on the broker side; contact [CData Support](https://www.cdata.com/support/submit.aspx) if you need it.
  </Accordion>
</AccordionGroup>

## Common Errors

<AccordionGroup>
  <Accordion title="No NameID or email is provided in the assertion.">
    * Set the Subject Name Format to **EmailAddress**.
    * Make sure the email claim exists in the assertion and is mapped to the correct attribute.
  </Accordion>

  <Accordion title="The certificate or signature is rejected.">
    The certificate registered with the broker has to be PingFederate's signing certificate. Confirm it is the current signing certificate and that it was provided in full, including the header and footer lines:

    ```
    -----BEGIN CERTIFICATE-----
    Every line of the certificate
    -----END CERTIFICATE-----
    ```

    Because the certificate is held on the broker side, contact [CData Support](https://www.cdata.com/support/submit.aspx) if it needs to be updated, for example after a certificate rollover.
  </Accordion>

  <Accordion title="Sign-in completes but the redirect goes to the wrong place.">
    Confirm that the ACS URL set in PingFederate matches the callback URL exactly. It follows this pattern, where the tenant and connection name are the values CData provides when SSO is enabled for your account:
    `https://<YOUR-AUTH0-TENANT>.auth0.com/login/callback?connection=<CONNECTION_NAME>`

    If you do not have the exact values, contact [CData Support](https://www.cdata.com/support/submit.aspx).
  </Accordion>
</AccordionGroup>

To enable SSO for your account or for additional help, contact [CData Support](https://www.cdata.com/support/submit.aspx).


# Playground
Source: https://docs.cloud.cdata.com/en/Playground

The ***Playground*** page enables you to harness AI to get answers from your connected data. The Playground interface provides connection assistance to many common data sources, such as Jira, GitHub, and Slack. Once you are connected, you can ask natural-language questions about the data in the sources.

## Connect to Your Data

Connect AI's Playground allows you to connect data sources to CData's remote MCP server and obtain insights from your data in real time without a third-party integration tool.

<Frame>
  <img alt="Playground" />
</Frame>

The home page of Playground contains commonly used data sources. Click **Explore Additional Sources** for more options. Click a source, and if the source is not already connected, Connect AI guides you through the appropriate steps to connect the source.

<Note>Click **Connect Integrations** if you want to use a third-party integration tool (such as ChatGPT) to query your data rather than Connect AI Playground.</Note>

For example, click the **Atlassian Jira** tile. If you are not yet connected, the Playground AI asks for your Jira URL to connect to the account. Once you submit a valid URL, the AI creates the Jira connection and asks you to authenticate it using OAuth. Save the connection.

<Frame>
  <img alt="Authenticate Jira" />
</Frame>

After you set up the Jira account, the Playground first checks if you have user-level or connection-level context, or instructions, about how AI should query your data. See [Context Editor](/en/Context-Editor) for more information.

<Note>Adding information in the Context Editor improves the prompt's answers, but it is not required.</Note>

Next, Playground runs a sample prompt to make sure you are connected to the data source, such as "Give me the 5 most recent tickets created in Jira and give me the summary." When the prompt is successful, submit your own prompt. The remote MCP server works to access the relevant catalogs, schemas, and tables. The Playground might prompt you for more information to narrow down the data you need.

You can expand the results of the prompt to obtain details about how the AI tools accessed the data:

<Frame>
  <img alt="Expand prompt results" />
</Frame>

In the example above, the prompt called the tools `getCatalogs`, `getSchemas`, and `executeQuery`.

Click **Reset Chat** to return to the Playground main menu and connect additional data sources.

## Chat Records

Chat records are saved for 30 days so you can return to them later. Click the three dots to the right to rename your prompt or delete it permanently.

## Examples

The following are some of the questions you can ask Playground about your data:

* ***In my Salesforce connection, which deals have we closed in the past month, and what is the total?***

* ***In my LinkedIn Ads connection, summarize the performance for the last 30 days by campaign.***

* ***Which e-commerce products generate the highest gross margin according to NetSuite?***

* ***Identify Salesforce stalled opportunities and explain why they're at risk.***

For a more complete list of prompt ideas, see the CData [prompt library](https://www.cdata.com/ai/prompt-library/). You can filter prompts by data source.

## Ask AI to Search the Documentation

Playground also lets you ask questions about the Connect AI documentation. For example, you can ask Playground: "How do I connect to my Salesforce data?" or "How do I change my email address?" Playground might ask follow-up questions to further assist you.

## Limitations

Playground operates within specific boundaries, as follows:

* **Permissions**: Access to data, including the ability to run queries, is based on catalog permissions granted to the user. Tools such as `getSchemas`, `getTables`, `getColumns`, `getCatalogs`, and `executeQuery` are only accessible with sufficient catalog permissions.

  <Warning>Playground does not perform data deletion queries under any circumstances.</Warning>

* **Query Limits**: Only SELECT, INSERT, UPDATE, and stored procedures are supported. Query responses also cannot exceed 100 rows.

* **Execution**: Actions are limited to the Connect AI ecosystem. Actions or queries outside of the system are ignored.

* **Privacy and Security**: Playground accesses only relevant data and metadata within the Connect AI system. It does not query data or systems outside of authorized Connect AI catalogs.


# SAML SSO Troubleshooting
Source: https://docs.cloud.cdata.com/en/SAMLTroubleshooting

Common questions and issues when configuring SAML as your SSO provider for Connect AI, with suggested solutions.

<Note>
  Connect AI uses Auth0 as its managed identity broker. Any step below that refers to the Auth0 tenant, domain, plan, or Rules and Actions is configured by CData on the broker side and is not something you set up yourself. If one of those applies to your issue, contact [CData Support](https://www.cdata.com/support/submit.aspx). The remaining steps are configured in your own identity provider.
</Note>

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="Is IdP-initiated login supported?">
    Both SP-initiated and IdP-initiated SAML flows work. For IdP-initiated login to succeed, the ACS URL must carry the connection name and your IdP must reference the matching SP Entity ID.
  </Accordion>

  <Accordion title="Can I limit who is able to log in?">
    Yes. You control this on your side by gating on group membership at the IdP. As a second layer, claims can be passed through and evaluated in Auth0 using Rules or Actions, but that part is configured by CData on the broker side; contact [CData Support](https://www.cdata.com/support/submit.aspx) if you need it.
  </Accordion>
</AccordionGroup>

## Common Errors

<AccordionGroup>
  <Accordion title="No NameID or email is found in the assertion.">
    * Verify that the SAML assertion includes a NameID and that it resolves to the user's email address.
    * Inspect the raw SAML response with a browser tool such as SAML-tracer to see what the IdP actually sends.
  </Accordion>

  <Accordion title="Certificate or signature is rejected.">
    Make sure the signing certificate was exported in PEM format, including the surrounding header and footer lines:

    ```
    -----BEGIN CERTIFICATE-----
    The full body of the certificate
    -----END CERTIFICATE-----
    ```
  </Accordion>

  <Accordion title="Login redirect or callback does not complete.">
    The ACS URL set in your IdP has to match the callback URL exactly. It follows this pattern, where the tenant and connection name are the values CData provides when SSO is enabled for your account:
    `https://<AUTH0-TENANT>.auth0.com/login/callback?connection=<CONNECTION_NAME>`

    If you do not have the exact values, contact [CData Support](https://www.cdata.com/support/submit.aspx).
  </Accordion>
</AccordionGroup>

To enable SSO for your account or for additional help, contact [CData Support](https://www.cdata.com/support/submit.aspx).


# User Provisioning and SSO
Source: https://docs.cloud.cdata.com/en/SCIM

Connect AI supports Single Sign-On (SSO) and user provisioning via Just-in-Time (JIT) and System for Cross-domain Identity Management (SCIM).

The following user onboarding and access management modes are available in Connect AI:

* [**Email Invitation**](/en/SCIM#email-invitation): An administrator invites users to the account individually by email.
* [**SSO + JIT**](/en/SCIM/SSO): Users can sign in through your company's SSO provider. Just-in-Time (JIT) provisioning automatically creates user accounts on first SSO login (requires SSO).
* [**SCIM Users**](/en/SCIM/SCIM-Users): Standardizes the process of granting individual user access to Connect AI and removing user access from Connect AI.
* [**SCIM Groups**](/en/SCIM/SCIM-Groups): Standardizes the process of provisioning groups of users to Connect AI, assigning roles, and removing groups from Connect AI.

<Note>
  **Microsoft Entra ID administrators:** Connect AI does not appear in the Microsoft Entra application gallery. Create a new application in Entra to enable SCIM provisioning. See [SCIM Users](/en/SCIM/SCIM-Users) and [SCIM Groups](/en/SCIM/SCIM-Groups) for setup details.
</Note>

## Email Invitation

An Administrator or User Administrator can invite users to Connect AI individually by email. The Administrator or User Administrator sets the user roles and permissions. See [Users](/en/Users) for instructions on inviting users.


# SSO
Source: https://docs.cloud.cdata.com/en/SCIM/SSO

Connect AI supports Single Sign-On (SSO) with multiple identity providers.

Connect AI supports SSO with multiple identity providers. To enable SSO for your account, contact [CData Support](https://www.cdata.com/support/submit.aspx).

## Configure SSO in Your Identity Provider

CData Support initiates the SSO setup and provides the callback URL that you must register in your identity provider. After you register the application and gather the required credentials, send them to CData Support to complete the configuration. CData Support handles the broker-side setup (Auth0 configuration, rules, and routing). You do not handle those directly.

For more information about configuring SSO, refer to [Single Sign-On](https://auth0.com/docs/authenticate/single-sign-on) in the Auth0 documentation.

## SSO User Provisioning (Without JIT)

SSO handles authentication only. Before a user can sign in via SSO, they must have a Connect AI account. Without JIT provisioning enabled, an Administrator must invite the user by email first. See [Users](/en/Users) for details.

## JIT User Provisioning

<Note>Your account must already have SSO configured to enable JIT provisioning.</Note>

JIT provisioning automatically creates a user account the first time someone successfully authenticates through SSO. The Connect AI Administrator does not have to invite the user manually. The new user receives the role that has been configured by the Administrator in the **Settings** page (the **Security** tab) by turning on **Just-in-Time User Provisioning** for the selected email domain and role.

<Frame>
  <img alt="JIT Provisioning" />
</Frame>

An Administrator or User Administrator can modify the roles and permissions later. See [Permissions and Access Control](/en/Permissions) for details on user roles and permissions.

If the new user's SSO login reaches the maximum number of seats, the user's provisioning is denied. The Administrator receives an alert.

## Troubleshooting

For common questions and errors for each SSO provider, see the following troubleshooting guides:

* [SAML](/en/SAMLTroubleshooting)
* [OpenID Connect](/en/OpenIDConnectTroubleshooting)
* [Google Workspace](/en/GoogleWorkspaceTroubleshooting)
* [Microsoft Entra ID](/en/MicrosoftEntraIDTroubleshooting)
* [Active Directory Federation Services (ADFS)](/en/ADFSTroubleshooting)
* [Active Directory/LDAP](/en/ActiveDirectoryLDAPTroubleshooting)
* [PingFederate](/en/PingFederateTroubleshooting)
* [Okta Workforce Identity Cloud](/en/OktaTroubleshooting)


# Security
Source: https://docs.cloud.cdata.com/en/Security

Connect AI implements a layered security model designed to protect data both at rest and in transit.

## Key Vaults

By using key vaults instead of entering data source information directly into the Connect AI user interface, you can have centralized control of all your credentials. You can establish an audit trail in your vault logs every time Connect AI reads a credential. You can also regularly update values in your vault without affecting your data source connection in Connect AI.

<Note>
  * Azure Key Vault is currently supported, with more vault support to come. This feature is only available in Connect AI's Business tier.
  * Not available for Connect AI Embed.
  * Only **Shared Authentication** is supported when key vaults are turned on.
</Note>

### Use a Key Vault for a Connection

Follow these steps to add your Azure key vault to Connect AI and then use the key vault for your connection.

<Steps>
  <Step>
    Enter your Azure Key Vault information in the [**Keys**](/en/Settings/Keys) tab of the **Settings** page.
  </Step>

  <Step>
    In the **Add Connection** page for your connection, toggle on **Use Key Vaults to Authenticate**. This enables the connection to use secrets stored in a key vault for its credentials.

    <Frame>
      <img alt="Use Key Vaults" />
    </Frame>
  </Step>

  <Step>
    In the **Key Vault** drop-down list, select the key vault to use for the connection. Key icons (<Icon icon="key" />) then appear next to the connection's credential fields (for example, **User** and **Password**).
  </Step>

  <Step>
    Click the field's key to change the key from outlined to solid, and then enter the vault secret in the field.

    * If the key is outlined (<Icon icon="key" />), the field is treated like a normal input field.
    * If the key is solid (<Icon icon="key" />), the value is treated as the name of a secret in the selected key vault, NOT the actual value of the field. For example, you can enter *salesforce-password* to reference the Salesforce password in the key vault.
  </Step>

  <Step>
    Save and test your credentials as usual.
  </Step>
</Steps>

## Rate Limits

The Connect AI rate limit is 100 requests per user per minute. This limit is shared across all data sources, so if a user issues 70 requests in a minute to one connection, that user can only issue 30 more requests to another connection in the same minute. Note that requests with excessively long response times might time out. If your request times out, please refine the query to reduce the time it takes to execute.

## IP Allowlist

Connect AI uses a range of static IP addresses to communicate with external data sources. To ensure that you can access your data, you must allow these static IP addresses in your data sources. The table below lists these IP addresses.

| IP Addresses (CIDR) | IP Addresses (Range) |
| :- | :- |
| 52.224.0.160/28 | 52.224.0.160 - 52.224.0.175 |
| 4.154.117.160/28 | 4.154.117.160 - 4.154.117.175 |

## Logging and Audit

CData Connect AI provides comprehensive logging and audit capabilities to help you monitor data access, track system activity, and maintain compliance with security and regulatory requirements. The platform captures detailed information about user actions, data queries, connection activity, and system events. See [Logs](/en/Logs) for details.

You can forward these audit log events to an external Security Information and Event Management (SIEM) platform in real time, enabling your security team to monitor Connect AI activity alongside other enterprise systems for threat detection, compliance reporting, and incident response. Configure SIEM endpoints in the [**SIEM Endpoints**](/en/Settings/Siem-Endpoints) tab of Settings.

## Personally Identifiable Information (PII)

Personally identifiable information (PII) is any data that can identify a specific individual, either on its own or when combined with other information. Common examples include names, email addresses, phone numbers, government identifiers such as Social Security numbers, financial details such as credit card numbers, and location data.

Because Connect AI moves data between your sources and the applications, AI agents, and users that consume it, that data can include PII. Many regulations govern how PII must be handled, including the California Consumer Privacy Act (CCPA / CPRA), the Gramm-Leach-Bliley Act (GLBA), the Payment Card Industry Data Security Standard (PCI DSS), and the Health Insurance Portability and Accountability Act (HIPAA). Mishandling PII can lead to regulatory penalties, loss of customer trust, and increased security risk.

Protecting PII typically involves identifying where sensitive values occur and controlling how they are exposed, for example by redacting or blocking them before they reach a user or a downstream system.

Enter PII rules on the [Data Security](/en/Data-Security) page.

<Frame>
  <img alt="Data Security" />
</Frame>

## Security Compliance

Connect AI prioritizes data security and regulatory compliance, enabling users to integrate data from any application with confidence and without compromising sensitive information.

Connect AI maintains comprehensive, globally recognized security and compliance frameworks to protect customer data, including SOC 2 Type II, ISO-certified security standards, and GDPR compliance. These measures ensure our customers can operate securely and meet regulatory requirements across industries and regions.

You can find more detailed information including architecture documentation, security policies, data retention policies and more from the Connect AI [Security Kit](https://www.cdata.com/security/).


# Toolkits
Source: https://docs.cloud.cdata.com/en/Toolkits

Connect AI allows Admin users to define toolkits containing custom MCP tools for repeatable operations in your AI-driven workflows.

Custom MCP Tools give you precise control over agent behavior by codifying specific actions into reusable, deterministic steps that execute exactly as defined—every time. You create custom tools within a toolkit and then provide the endpoint to the toolkit to your AI agent.

For example, you can create an AI agent using Jira custom tools: the agent finds all unassigned high-priority Jira tickets and assigns them to the appropriate team members. You define the Jira custom tools in a toolkit. You then provide the AI agent with the toolkit endpoint containing the custom tools.

Access the **Toolkits** page by selecting **AI > Toolkits** in the Connect AI navigation menu.

<Frame>
  <img alt="List of toolkits" />
</Frame>

The **Toolkits** home page contains the following:

* The name of the available toolkits.
* The number of custom tools each toolkit contains.
* An icon of the data sources contained within each toolkit.
* A **Copy URL** button for copying the URL to the AI agent.
* A menu icon enabling you to edit, copy, or delete the toolkit.

## Prerequisites

* MCP toolkits are available to Growth+ customers only.
* Only Admin users can create and configure custom tools.
* To add connection tools, you need to set up one or more connections. See [Sources](/en/Sources) for more information.
* To add workspace tools, you need to set up one or more workspaces. See [Workspaces](/en/Workspaces) for more information.

## Custom Tool Types

There are two main tool types you can add to your toolkit: **connection tools** and **workspace tools**. In the edit screen of the toolkit, an icon represents connection tools, and a folder icon represents workspace tools.

<Frame>
  <img alt="Edit toolkit page" />
</Frame>

* **Connection Tools**–these tools apply to one or more connections. Within the connection tool, you can activate universal tools and source tools. You can also create custom tools for repeatable SQL queries and operations. Note that once connection(s) are assigned to a connection tool, they cannot be assigned to another connection tool.
* **Workspace tools**–these are tools that perform an action specific to the assets in your workspace. Within the workspace tool, you can activate universal tools. You can also create custom SQL tools.

Within connection and workspace tools, select the tab to activate the specific tools available for the tool type.

* **Universal Tools**–these are data exploration and manipulation operations built into Connect AI. They expose operations such as `getSchemas`, `getTables`, and `executeProcedure`. They are available for both connection and workspace tools. If you activate the tool, the tool includes every asset in the connection(s) or every asset in the workspace. Click an individual tool to view the description, annotations, and parameters of the tool. Click the information button for a complete explanation of the annotations. Note that universal tools can have dependencies: enabling one tool may require another tool to be enabled.
* **Source Tools (connection tools only)**–you can configure actions such as get, search, and create for each asset in a connection in order to optimize your query. For example, if you have a Jira connection, you can enable tools to search for, create, update, and delete issues. You can edit each tool to add AI instructions. You can also view required and optional parameters.
* **Custom SQL Tools**–you can create custom SQL tools for repeatable queries and operations. You can add optional or required parameters that are input to the SQL query.

## Add a New Toolkit

<Steps>
  <Step>
    In the main **Toolkits** page, click **Add**. An **Add Toolkit** dialog appears.
  </Step>

  <Step>
    Enter the name of the toolkit, and click **Confirm**. The new toolkit appears on the main **Toolkits** page.
  </Step>

  <Step>
    Select the toolkit to configure it.
  </Step>

  <Step>
    Add the **Toolkit Name**. The **MCP Remote Server URL** is autogenerated. This is the URL that you copy and paste into your MCP client application.
  </Step>

  <Step>
    Add **Server Instructions** to the MCP server, setting general toolkit boundaries such as "Use customer data only. Do not use external data."
    <Note>Not all MCP clients support server instructions.</Note>
  </Step>

  <Step>
    Click **Save Changes**. You can now add custom tools to the toolkit.
  </Step>
</Steps>

## Add a Custom Tool to a Toolkit

<Steps>
  <Step>
    Open the toolkit you want to add a tool to.
  </Step>

  <Step>
    Select whether the tool is a connection or workspace tool.
  </Step>

  <Step>
    Follow the steps in the wizard to add connection(s) or the workspace where the tool should reside. Click **Confirm**. The tool appears in your toolkit editor.
  </Step>

  <Step>
    Select the tool to edit it. The tool editor contains the following tabs: **Universal Tools**, **Source Tools** (connection tools only), and **Custom Tools**.
  </Step>

  <Step>
    In the **Universal Tools** tab, enable the universal tools for the connection or workspace. Select a tool to view a description of the tool, the tool's annotations, and the tool's parameters. Some tools have dependencies with other tools and must be enabled together.
  </Step>

  <Step>
    (Connection tools only) In the **Source Tools** tab, enable the tools to be used for the source(s). Select a tool to view a description of the tool and the tool's optional and required parameters. If desired, add **AI Instructions (MCP Context)**. This is where you can set boundaries and define the intent of the tool. Here are some guidelines for writing effective AI instructions for a custom tool:

    * Be clear and specific about the tool's purpose. Define what the tool does and what inputs it accepts.
    * Set clear boundaries. Explicitly state what the tool should and should not do.
    * Test your instructions against a wide variety of inputs.
  </Step>

  <Step>
    The **Custom Tools** tab is for advanced users. See [Add a Custom SQL Tool](#add-a-custom-sql-tool) for details on how to create custom SQL tools for your toolkit.
  </Step>

  <Step>
    When you are satisfied with the configuration of the custom tools, click **Save Changes**.
  </Step>
</Steps>

## Add a Custom SQL Tool

Custom tools can help you improve response accuracy in your AI agent. To add a custom SQL tool:

<Steps>
  <Step>
    Within the toolkit, select a connection or workspace tool in which to create the custom tool.
  </Step>

  <Step>
    In the tool editor, click the **Custom Tools** tab.

    <Frame>
      <img alt="Add a custom tool" />
    </Frame>
  </Step>

  <Step>
    Click **Add**. The custom tool editor appears.
  </Step>

  <Step>
    In the custom SQL editor, you can edit the tool name and add AI instructions. You can set boundaries for the type of data that can be returned.
  </Step>

  <Step>
    Create a SQL statement. The documentation contains a complete [SQL Reference](/en/SQL-Reference/SQL-Reference) for guidance.
  </Step>

  <Step>
    Optionally, add parameters to the SQL statement. If you add parameters to the SQL statement, you must add the parameter name in the **Parameters** section of the tool's definition.

    <Frame>
      <img alt="Custom SQL tool" />
    </Frame>

    <Note>If you use standard SQL for the SQL statement, any parameters you add must be **required** parameters, or the query fails. See [Use SQL Custom Templates](#use-sql-custom-templates) for instructions on creating queries with optional parameters.</Note>
  </Step>

  <Step>
    Click **Validate SQL**. You can also **Open in Data Explorer** to see the results of the SQL statement.
  </Step>

  <Step>
    Click **Save Changes** to save the custom SQL tool.
  </Step>

  <Step>
    The tool appears in your toolkit. When you are satisfied with the tool's configuration, enable the tool.
  </Step>
</Steps>

### Use SQL Custom Templates

Instead of standard SQL, you can use custom SQL templates to create a SQL statement in the custom SQL tool. Custom templates allow you to have optional parameters, or a combination of optional and required parameters.

The following two examples follow the SQL template for Bullhorn CRM for a `SELECT` statement. Refer to the data model for your data source to obtain the accepted parameters for the data source.

The following example shows a custom SQL template with both required and optional parameters:

```sql wrap theme={null}
SELECT * FROM {{catalog_name}}.BullhornCRM.Candidate
WHERE FirstName = @first_name
AND LastName = @last_name
{% if address %} AND AddressAddress = @address {% endif %}
{% if city %} AND AddressCity = @city {% endif %}
{% if state %} AND AddressState = @state {% endif %}
{% if zip %} AND AddressZip = @zip {% endif %}
{% if country_name %} AND AddresscountryName = @country_name {% endif %}
{% if email %} AND Email1 = @email {% endif %}
{% if mobile_phone %} AND MobilePhone = @mobile_phone {% endif %}
```

`@first_name` and `@last_name` are required. The rest of the parameters are optional. In the query, you can include any of the optional parameters, or none.

In this SQL template example, all parameters are optional individually, but the template requires that at least one be provided.

```sql wrap theme={null}
{% if first_name == blank and last_name == blank and email == blank and mobile_phone == blank and city == blank and state == blank %}
SELECT 'Error: at least one search parameter is required' AS ErrorMessage
{% else %}
SELECT * FROM {{catalog_name}}.BullhornCRM.Candidate
WHERE 1=1
{% if first_name %} AND FirstName = @first_name {% endif %}
{% if last_name %} AND LastName = @last_name {% endif %}
{% if email %} AND Email1 = @email {% endif %}
{% if mobile_phone %} AND MobilePhone = @mobile_phone {% endif %}
{% if city %} AND AddressCity = @city {% endif %}
{% if state %} AND AddressState = @state {% endif %}
{% endif %}
```

This query succeeds as long as one parameter is included. `WHERE 1=1` lets you safely append `AND` clauses without worrying about whether any conditions come before them.

## Add the Endpoint to Your Agent

Connect AI provides an endpoint to each toolkit. In the main **Toolkits** page, click **Copy URL** for the desired toolkit. If you want to view the actual URL, you can open the toolkit editor page. Copy the **MCP Remote Server URL** and paste it into your AI agent as a custom connector.


# Workspaces
Source: https://docs.cloud.cdata.com/en/Workspaces

The **Workspaces** feature is a data catalog that streamlines the accessibility of diverse data sources.

## Overview

Workspaces provide a way to organize, catalog, and control access to specific data (assets) in Connect AI. You can bundle related assets separately in a scalable way. Workspaces offer a customizable organization scheme that streamlines data analysis across numerous business functions.

In the Connect AI data catalog, you can view a preview of the workspace’s column metadata.

Workspace assets can be:

* **Folders**–you can create one level of folders within a workspace.
* **Tables and Views**–from connected Connect AI data sources
* **Derived Views**–derived from one or many data sources in Connect AI

Tables, views, and derived views are exposed directly without transformations, so the column names and other properties remain the same. Any table, view, or derived view can be added to any number of workspaces. They can be referenced by a unique **Alias**. Tables that are workspaces support full CRUD capabilities.

## Add a Workspace

Workspaces are the highest level of organization. They are customizable to adjust to various business needs. A business unit like marketing or data science can have their own separate workspaces. Sales may organize folders in their workspace for each client. Teams can pick the structure that supports them best.

To get started, you can create a workspace using the following steps:

<Steps>
  <Step>
    Click **Workspaces** on the left side of the dashboard.
  </Step>

  <Step>
    Click **Add** on the top right side.
  </Step>

  <Step>
    Enter a **Workspace Name**.
  </Step>

  <Step>
    Click **Confirm** to create your new workspace.
  </Step>
</Steps>

After setting a name and description for a *Workspace*, SQL Server, OData, and OpenAPI **Endpoints** are automatically generated. Endpoints are the door to a wide range of connections that form the backbone of workspaces.

To view connection details for connecting from a workspace via Virtual SQL Server, OData, or OpenAPI, click **View Endpoints**. The **Endpoints** dialog contains three tabs, one for **Virtual SQL Server**, one for **OData**, and one for **OpenAPI**.

### Inbound Connections

When connecting to Connect AI from a client application, you can connect directly to a workspace via workspace-specific endpoints. Connect AI supports several endpoints for inbound connections, including a REST API, Virtual SQL Server, OData, and OpenAPI. You can identify endpoints quickly via a configurable naming structure that places periods between workspace, folder, and asset names by default—for example, *Workspace.Folder.Asset*.

Connect AI supports the OpenAPI specification version 2.0 and 3.0, allowing you to connect no-code/low-code applications that integrate with OpenAPI. Connect AI allows you to connect a workspace via OpenAPI by downloading an OpenAPI document from a workspace and importing the file in your client application.

#### Connect to the REST API

To make a connection to the REST API, add a URL parameter to the REST API URL named “workspace”. Set this to the name of the workspace you want to query. This works with both the GET operation on the metadata endpoint, as well as the POST operation on the query and batch endpoints. Note that the /exec endpoint does not support workspaces.

#### Connect via Virtual SQL Server

The **Virtual SQL Server** tab of the **Endpoints** dialog contains the settings you need to connect from a workspace via Virtual SQL Server clients. Copy the settings in the dialog.

<Frame>
  <img alt="Workspace SQL Server settings" />
</Frame>

* **Username**—your username to connect to a workspace is in the format of `[your_email_address]@[workspace_name]`.
* **SQL Server Host Name**—the SQL Server host name (*tds.cdata.com*).
* **Port**—the SQL Server port (*14333*).
* **Database**—the name of the workspace (if required).
* **Password**—click **Create PAT** to create a Personal Access Token to use as your password during authentication.

#### Connect via OData

The **OData** tab of the **Endpoints** dialog contains the settings you need to connect from a workspace via OData clients. Copy the settings in the dialog.

<Frame>
  <img alt="Workspace OData settings" />
</Frame>

* **Username**—your username to connect to a workspace is in the format of your email address.
* **OData URL**—the workspace name you want to connect to. The URL has the format `https://cloud.cdata.com/api/odata/{workspace_name}`.
* **Password**—click **Create PAT** to create a Personal Access Token to use as your password during authentication.

#### Connect via OpenAPI

The **OpenAPI** tab of the **Endpoints** dialog contains the settings you need to connect from a workspace via OpenAPI. You can generate an OpenAPI specification file for the selected workspace. This file can be used in client applications to integrate with Connect AI via OpenAPI.

<Frame>
  <img alt="Workspace OpenAPI" />
</Frame>

<Steps>
  <Step>
    Select version 2.0 or 3.0 of OpenAPI.
  </Step>

  <Step>
    Toggle **Convert array types to strings** on if the client application does not support array types (such as Microsoft Power Apps).
  </Step>

  <Step>
    Click **Download** to download the OpenAPI specification file for the workspace. This is the file that is imported into the client application.
  </Step>

  <Step>
    You can also copy and paste the **OpenAPI URL**.
  </Step>
</Steps>

#### Connect to Development Tools (JDBC/ODBC/SSIS)

To make a connection from the workspace to CData development tools, enter the workspace name in the **Workspace** field in the **Advanced** tab of the driver for Connect AI. Below is an example for the JDBC driver.

<Frame>
  <img alt="JDBC specify workspace" />
</Frame>

#### Connection Authentication

To authenticate, use your Connect AI email address as your username. You need a Personal Access Token (PAT) to use as your password. You can generate a PAT in the **Endpoints** dialog or on the [Settings](/en/Settings/Personal-Access-Tokens) page.

## Workspace Assets

The assets created within workspaces link to specific data items and provide a second layer of organization. You can organize assets into folders, but you cannot create subfolders. On the left of the asset is an icon specifying whether the asset is a folder, table, or derived view. On the right of the asset is an icon displaying the data source of the asset (not applicable for derived views).

<Frame>
  <img alt="Workspace assets" />
</Frame>

To create an asset inside of the workspace:

<Steps>
  <Step>
    Within the workspace, click **Add** on the top right side. The **Add Asset** dialog appears.

    <Frame>
      <img alt="Add asset" />
    </Frame>
  </Step>

  <Step>
    Select from the menu what you want to add:

    * **Folder**
    * **Tables and Views**
    * **Derived Views**
      If you select **Folder**, enter the folder name. If you select **Tables and Views**, you must select the connection and the tables or views to add. If you select **Derived Views**, you must select the derived views to add.
  </Step>

  <Step>
    Click **Confirm**.
  </Step>
</Steps>

When you click on an asset in a workspace, the horizontal tabs offer the following functionality:

* **Columns**–a table with the column metadata
* **Preview**–the connected data item’s contents in a preview table
* **SQL**–a generated reference SQL query for a table, view, or derived view, including the configurable **Alias** which is an important reference when querying.

### Data Model

The data model follows a `Workspace.Folder.Table` design. If no folder is present in the hierarchy, it displays as `[ROOT]`. For more information about the data model, refer to [SQL Reference](/en/SQL-Reference/SQL-Reference#data-model).


# Accounts
Source: https://docs.cloud.cdata.com/en/Accounts-Embedded

The ***Accounts*** page enables you to add and manage the sub-accounts in your Connect AI Embed account.

<Frame>
  <img alt="" />
</Frame>

The **Accounts** page displays the following information about each sub-account:

* **Accounts**—The name and external Id name of the sub-account.
* **Account Id**—The internal CData account Id of the sub-account.
* **# of Connections**—The number of connections associated with the sub-account.
* **Last Query**—The date and time the sub-account last executed a query.
* **Account Actions**—The icons in the last column represent the various actions you can perform on an account.
  * **Edit (🖉)**—Edit the account name and external Id of the sub-account.
  * **Delete (🗙)**—Delete the sub-account.

To add a new sub-account, follow these steps:

<Steps>
  <Step>
    Click **+Add Account**.
  </Step>

  <Step>
    Enter the **Account Name** and **External ID**. The external Id is the customer's identifier.
  </Step>

  <Step>
    Click **Confirm**.
  </Step>
</Steps>


# Reference Architecture
Source: https://docs.cloud.cdata.com/en/Architecture-Embedded

Connect AI Embed uses a three-zone architecture. Understanding the separation between your infrastructure, the Connect AI Embed managed service, and your customers' data sources helps you design your integration correctly and implement the right security controls in the right layer.

## The Three Zones

### Zone 1: Your Infrastructure (ISV-Hosted)

This is the application and backend your team builds and operates. It includes:

* Your AI experience or agent code
* Your backend server, which generates and signs JWTs
* The MCP client session that connects your agent to Connect AI Embed
* Your LLM or AI model
* Optional: application storage for persisting query results
  Your infrastructure is responsible for identity, access control, JWT lifecycle, user-level logging, and governing which of your end users can invoke AI features.

### Zone 2: Connect AI Embed Managed Service (CData-Operated)

This is the CData-operated platform your agent communicates with. It includes:

* The MCP endpoint your agent calls
* The User Management API, Metadata API, Query API, and Credentials Manager
* The standard MCP tools available to your agent
* Connection lifecycle management: authentication flows, token refresh, and credential storage
  CData operates this layer, including security, uptime, API maintenance, and connector updates. You configure it but do not host it.

### Zone 3: Customer Data Sources

These are the systems your customers connect through Connect AI Embed. They include:

* SaaS applications such as Salesforce, Jira, NetSuite, and HubSpot
* On-premises databases and file systems (accessible via Private Cloud Connector)
* Cloud data warehouses such as Snowflake, BigQuery, and Databricks
* Hundreds of additional supported sources
  Data in Zone 3 is accessed live at query time. It is not copied, replicated, or persistently stored in the Connect AI Embed service.

## How a Request Flows

A typical request from end user to data and back follows this sequence:

<Steps>
  <Step>
    The end user inputs a natural language request in your application UI.
  </Step>

  <Step>
    Your backend generates a signed JWT identifying the sub-account and scoping the request to specific connection IDs.
  </Step>

  <Step>
    Your agent uses MCP tools to discover available sources and schema, then submits a structured query.
  </Step>

  <Step>
    The Connect AI Embed MCP endpoint maps the tool call to the authenticated connection and executes the query against the live source.
  </Step>

  <Step>
    Connect AI Embed returns results to your agent, which renders the answer for the end user.
    See [Authentication](/en/API/Authentication-Embedded) in the API Reference for JWT configuration details. See [MCP](/en/API/MCP-Embedded) in the API Reference for the full tools reference and request flow example.
  </Step>
</Steps>


# Build Your First Agent
Source: https://docs.cloud.cdata.com/en/Build-Agent-Embedded

This guide assumes you have a parent account set up and a JWT signing key configured. It takes you from zero to a working agent querying a customer's live data source in three steps.

For initial account setup, see the [Quick Start Guide](/en/Quick-Start-Embedded). For a diagram of how the components fit together, see [Reference Architecture](/en/Architecture-Embedded).

## Step 1: Create a Sub-Account for Your Customer

Each of your customers receives an isolated sub-account. Create one using the Account API:

```bash wrap theme={null}
POST https://cloud.cdata.com/api/poweredby/account/create
Authorization: Bearer <your-signed-JWT>
{
  "accountName": "acme-corp",
  "externalId": "your-internal-customer-id"
}
```

The response includes the `accountId` you use in subsequent calls for this customer. See the [Create Account](/en/API/Account-API) reference for full request and response details.

## Step 2: Create a Connection and Redirect Your Customer to Authenticate

Create a connection for the sub-account. Connect AI Embed returns a redirect URL that sends your customer to a hosted connection page where they authenticate using their own credentials.

```bash wrap theme={null}
POST https://cloud.cdata.com/api/poweredby/connection/create
Authorization: Bearer <your-signed-JWT-with-sub-account-id>
{
  "sourceType": "Salesforce"
}
```

The response includes a `redirectURL`. Send your customer to that URL. CData handles the authentication UI and credential lifecycle. When the customer completes authentication, Connect AI Embed redirects them back to your application with the `connectionId`.
See the [Create Connection](/en/API/Connection-API) in the API Reference and [Connection Flow](/en/Connection-Flow) for full details.

## Step 3: Point Your Agent at the MCP Endpoint and Start Querying

With a sub-account and connection in place, your agent can query live data through MCP. Generate a JWT scoped to the customer's connection and point your MCP client at the endpoint:

```bash wrap theme={null}
# JWT must include:
# iss: your parent account ID
# sub: the sub-account ID for this customer
# connection_ids: ["<connectionId from Step 2>"]

# Agent discovers available sources
getCatalogs()
# Response: ["Salesforce"]

# Agent queries live data
queryData("SELECT Id, Name, Amount FROM Opportunity WHERE IsClosed = 0")
```

The standard MCP tools are consistent across hundreds of sources. The same Get Schemas → Get Tables → Get Columns → Query Data pattern works whether your customer has connected Salesforce, Jira, NetSuite, or any other supported source.

See [MCP](/en/API/MCP-Embedded) in the API Reference for the full tools reference, including how to use getInstructions to get source-specific query guidance before writing your first query.


# Caching
Source: https://docs.cloud.cdata.com/en/Caching

***Caching*** allows you to fetch cached data from a database instead of retrieving live data. This can improve performance of data connections, since some drivers can be slow retrieving live data.

With the Connect AI caching feature, you select tables to be cached, or saved to a database. Connect AI then fetches data for the selected tables on a scheduled basis, ensuring swift and reliable access to data whenever you need it.

Note that when you enable caching of data, Connect AI runs database queries against the *cached* data, not the live data.

The **Jobs** page displays a list of jobs to run, including cache jobs.

<Frame>
  <img alt="Cache jobs" />
</Frame>

Select a **Job Type** of **Cache Jobs** and click **Apply** to view only cache jobs in the list.

For each job, the **Jobs** page displays the full connection and table information, the job type, the last time the job was run, and the status of the job. You can select multiple jobs to run immediately by selecting the jobs and clicking **Run** at the top of the page. You can also delete multiple jobs by selecting them and clicking **Delete** at the top of the page. Note that when you delete jobs, Connect AI deletes the associated cached data.

The **Jobs** page also allows you to disable a particular cache job, if you want to pause the scheduled job but not delete it. Use the toggle switch in the **Status** column to enable or disable a job. You cannot run a job manually as long as it is disabled. When a cache job is disabled, any queries of that data will use the live data source.

<Note>
  * Caching is not available for relational databases.
  * Caching is permitted for shared authentication only, not per-user authentication.
</Note>

## Incremental Updates

The Connect AI caching feature allows for incremental updates, improving performance. When you create a cache job, Connect AI tries to find date or date+time columns in the database that show which rows are new or have changed since the last run. Connect AI can then run the cache job for those rows only. Otherwise, Connect AI runs a full update.

## Configure Caching

Before you can use the caching feature, you need to configure a PostgreSQL database for your cached data.

To add a PostgreSQL connection for your cached data:

<Steps>
  <Step>
    Click **Setup Cache Connection**. The **Add PostgreSQL Connection** page appears.
  </Step>

  <Step>
    Set up authentication for your PostgreSQL connection. See [PostgreSQL](/en/Data-Sources/PostgreSQL) for detailed instructions.
  </Step>

  <Step>
    Click **Save & Test** to save your connection. You can now cache data to the PostgreSQL database.
  </Step>
</Steps>

You can edit your PostgreSQL connection at any time by clicking **Manage Cache Connection** from the main **Jobs** page. <Note>Modifying your connection results in the clearing of data already in the cache.</Note>

## Add a Cache Job

To add a new cache job, complete the following steps:

<Steps>
  <Step>
    On the **Jobs** page, click **Add Job**. This action displays the **Add Jobs** dialog. There are three steps to adding a job: **Select Connection**, **Add Tables**, and **Schedule Jobs** . You can return to any of the previous steps by clicking the step in the header or by clicking **Back**.

    <Frame>
      <img alt="Caching add jobs" />
    </Frame>
  </Step>

  <Step>
    Select a connection from the list of your connections in the dialog (Step 1), and then click **Next**.
  </Step>

  <Step>
    Select the tables from your connection that you want to add to the job (Step 2).

    <Frame>
      <img alt="Caching add tables" />
    </Frame>

    Connect AI displays the total number of datasets selected. Then click **Next**.
  </Step>

  <Step>
    Select how often you want the data to be updated, in increments of hours, days, weeks, or months (Step 3).

    <Frame>
      <img alt="Caching schedule jobs" />
    </Frame>
  </Step>

  <Step>
    Select a **Cache Scheme** (full or incremental) and **Time Check**.
    **Time Check Column** is for incremental updates only. Select a column in your table that Connect AI can use to determine which rows are new or have changed since the last run. This is typically a date or date+time column.
    <Note>If your data does not contain a time check column, Connect AI performs full updates only.</Note>
  </Step>

  <Step>
    When you are satisfied with the job you added, click **Confirm** to save the job. Otherwise, click **Back** or click one of the previous steps in the header to make changes.
    Your cache job now appears in the **Jobs** queue. Each table you selected for a given data connection is saved in the queue as a separate job.
  </Step>
</Steps>

## Edit a Cache Job

You can modify or delete a job at any time by clicking the edit or delete icons in the list. You can also run a job manually at any time by clicking **Run Now**.

<Frame>
  <img alt="Edit job" />
</Frame>

In the **Edit Job** page, you can do the following:

* Change the caching scheme, such as changing full updates to incremental updates.
* View the run history and status, making sure the job was successful.
* Change the log verbosity.
* Run a single job manually. You can run multiple jobs in the main **Jobs** page.
* Turn off caching. Note that if you turn off caching, queries go to the live data source until you turn caching back on.
* Refresh the cache. Refreshing the cache deletes all previously stored data and can take some time to complete.
* Delete the job. This deletes all the cached data in your database. You can delete multiple jobs in the main **Jobs** page.


# Caching
Source: https://docs.cloud.cdata.com/en/Caching-Embedded

The Caching user interface is a hosted caching configuration interface that you can expose to your sub-accounts for self-service cache management. It gives you two deployment options depending on how much control you want your customers to have over their own cache settings.

## Deployment Options

### ISV-Managed via API

Configure and manage caching centrally through the Connect AI Embed API. Sub-account users do not see a caching interface—all cache settings are controlled at the parent account level. Use this model when you want to enforce consistent cache behavior across all customers without giving them configuration access. Refer to the endpoints under [Job API](/en/API/Job-API) for details.

### Sub-Account Self-Service

Expose the hosted Embedded Caching UI directly within your product so that sub-account users can manage their own cache settings without involving your team. This reduces support escalations around caching and gives customers control over their own configuration.

## Accessing the Embedded Caching User Interface

The caching configuration API is accessible through the Connect AI Embed REST API. To expose the hosted UI to sub-account users, embed the provided UI component in your product. See [Generate Jobs URL](/en/API/Jobs-Page-API) to generate a URL that gives end users access to create or update their cache connection.


# Connection Flow
Source: https://docs.cloud.cdata.com/en/Connection-Flow

The following diagram shows the connection and authentication flow for your customer using Connect AI Embed to configure a connection.

<Frame>
  <img alt="" />
</Frame>

Creating a connection to a Connect AI data source from a client account involves the following steps:

<Steps>
  <Step>
    An end user of your customer’s account clicks **Add Connection** on your web page.
  </Step>

  <Step>
    Your application creates a JSON Web Token (JWT) signed by a private key and makes a request to the Connect AI Embed Create Connection API.
  </Step>

  <Step>
    Connect AI Embed returns a redirect URL to your application.
  </Step>

  <Step>
    The end user is redirected to the Connect AI **Add Connection** page.
  </Step>

  <Step>
    The end user adds connection information for the particular data connector, such as Salesforce, and then tests and saves the connection.
  </Step>

  <Step>
    Connect AI Embed calls [Create Connection](/en/API/Connection-API).
  </Step>

  <Step>
    Create Connection returns success or failure on the **Add Connection** page.
  </Step>

  <Step>
    The end user clicks the **Close** button. Connect AI Embed redirects with a connection Id back to your web page.
  </Step>

  <Step>
    Your web page now displays the end user’s list of connections.
  </Step>
</Steps>


# Dashboard
Source: https://docs.cloud.cdata.com/en/Dashboard-Embedded

The ***Dashboard*** page provides a high-level overview of recent queries and account activity for a particular account. It can also provide an overview of all your sub-account activity.

<Frame>
  <img alt="Dashboard" />
</Frame>

The drop-down list next to **Dashboard** allows you to view the dashboard for a single sub-account, or for all accounts.

The upper-right corner of the page displays buttons to adjust data for the past **1 Day**, **7 Days**, and **30 Days**. Clicking one of these buttons refreshes the page and adjusts the displayed data accordingly.

## Information Boxes

Information boxes at the top of the page display the quantity for each of these four categories in the selected time period:

* **Rows:** The rows that are processed
* **Queries:** The queries that are performed
* **Active Connections:** The active connections on your account

<Frame>
  <img alt="" />
</Frame>

Underneath the count, each box displays the percentage change compared to the previous time period. This percentage change adjusts dynamically based on the time period that is selected.

## Data Visuals

Under the information boxes, the **Dashboard** page displays two visuals:

* **Queries/Rows Over Time**
* **Queries/Rows by Connection**

### Queries/Rows Over Time

This bar graph shows the total number of queries or total rows returned in the sub-account over the selected time period. The x-axis displays the dates, and the y-axis displays the number of queries/rows.

<Frame>
  <img alt="" />
</Frame>

Each bar is composed of two sections:

* The number of successful queries or rows returned, displayed top portion of the bar and colored blue
* The number of failed queries, displayed as the bottom portion of the bar and colored red

Clicking the down arrow icon in the upper-right corner of the section opens an export menu. This menu enables you to export the graph as a data file.

### Queries/Rows by Connection

This table displays the number of queries or total rows by each connection in the selected time period.

<Frame>
  <img alt="" />
</Frame>

There are three columns in this table:

* **Connection:** The name that is given to the connection on the **Connections** tab
* **Queries:** The total number of queries, both successful and failed, that are made by the connection in the selected time period
* **Successful:** The percentage of queries from the connector that succeed in the selected time period

Clicking the name of a column sorts the table by that column. If the table is already sorted by the selected column, the sort function toggles between ascending and descending order.


# Azure Analysis Services
Source: https://docs.cloud.cdata.com/en/Data-Sources/AAS-Embedded



## Setup Guide

Follow these steps to connect Azure Analysis Services to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Analysis Services* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **URL** field, enter the URL of the Azure server instance. For example, `asazure://eastus.asazure.windows.net/serverCode`.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id found on the Overview page of the OAuth app used to authenticate to Microsoft SharePoint on Azure.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Azure Analysis Services sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Azure Analysis Services account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Azure Password">
    <Steps>
      <Step>
        In **User** enter the Azure Analysis Services username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id found on the Overview page of the OAuth app used to authenticate to Microsoft SharePoint on Azure.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** that you will use to access data.
      </Step>

      <Step>
        Enter your **OAuth Client Id**.
      </Step>

      <Step>
        Enter your **OAuth JWT Cert** OR your **OAuth Client Secret**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Analysis Services, see [this information page](https://cdn.cdata.com/help/OAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure Data Lake Storage
Source: https://docs.cloud.cdata.com/en/Data-Sources/ADLS-Embedded



## Setup Guide

Follow these steps to connect Azure Data Lake Storage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Data Lake Storage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Account** name for your Azure Data Lake Storage account.
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant**: either the domain name (for example, *contoso.onmicrosoft.com*) or the directory (tenant) ID.
      </Step>

      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Azure Data Lake Storage sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Azure account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant**: either the domain name (for example, *contoso.onmicrosoft.com*) or the directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned to your OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your OAuth application.
      </Step>

      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **Azure Tenant**: either the domain name (for example, *contoso.onmicrosoft.com*) or the directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned to your OAuth application.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert**: the certificate content for your client certificate.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type** that matches your certificate store format.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Password** if the certificate store is password-protected.
      </Step>

      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Managed Identity">
    <Steps>
      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Access Key">
    <Steps>
      <Step>
        Enter the **Access Key** for your Azure Data Lake Storage account.
      </Step>

      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SAS">
    <Steps>
      <Step>
        Enter the **Shared Access Signature** for your Azure Data Lake Storage account.
      </Step>

      <Step>
        (Optional) Enter the **File System** name in your Azure Data Lake Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Data Lake Storage, see [this information page](https://cdn.cdata.com/help/HDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure Data Lake Storage (Legacy)
Source: https://docs.cloud.cdata.com/en/Data-Sources/ADLSSync-Embedded



## Prerequisites

#### Whitelist CData IPs

To establish a connection to Azure Data Lake Storage, you need to allow access to Azure Data Lake Storage via CData’s IP. When hosting Azure Data Lake Storage behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure Azure Data Lake Storage Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

#### If Connect AI Is Configured to Run in the Same Region as Azure Data Lake Storage

If you have a firewall enabled and Connect AI is running in the same region as Azure Data Lake Storage, you need to configure virtual network rules and add Connect AI virtual network subnets to the list of allowed virtual networks. See Microsoft’s [documentation](https://learn.microsoft.com/en-us/azure/storage/common/storage-network-security?tabs=azure-portal#grant-access-from-a-virtual-network) for details. Contact [CData support](https://www.cdata.com/support/submit.aspx) if you need a list of region-specific fully qualified subnet IDs.

## Setup Guide

Follow these steps to connect Azure Data Lake Storage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Data Lake Storage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **File Format**—choose the file format type.
    * **Auth Scheme**—set to **Azure AD** (Entra ID).
    * **Azure Storage Account**—the name of the storage account.
    * **File System**(Optional)—enter the file system protocol.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Azure Data Lake Storage sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Azure Data Lake Storage account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Azure Data Lake Storage, see [this information page](https://cdn.cdata.com/help/HDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# ADP
Source: https://docs.cloud.cdata.com/en/Data-Sources/ADP-Embedded



## Prerequisites

Before you can establish a connection with ADP, go to ADP’s [API Central documentation](https://developers.adp.com/guides/quick-start-guides/adp-api-central-for-clients/api-guides/api-central-quick-start-guide) to learn how to obtain the necessary credentials.

The following is an overview of the steps:

<Steps>
  <Step>
    Create a new project and add a use case and name.
  </Step>

  <Step>
    Click **View project** and copy the client Id and client secret.
  </Step>

  <Step>
    Generate an SSL security certificate for your project, which contains a private key. Copy and securely save the private key for authenticating to the ADP API.
  </Step>

  <Step>
    ADP masks all sensitive personal information by default. Ask an ADP administrator to update this for API access if needed.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect ADP to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *ADP* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information in Connect AI:

    * **OAuth Client Id**—the client Id that you copied in the prerequisites.
    * **OAuth Client Secret**—the client secret that you copied in the prerequisites.
    * **SSL Client Cert**—First, paste the entire private key that you copied in ADP API Central. The private key begins with `---BEGIN PRIVATE KEY---` and ends with `---END PRIVATE KEY---`.
      Then, open the .pem file you downloaded from ADP API Central. The .pem file contains the public certificate. Copy and paste the contents of the .pem file after the private key information. The public certificate begins with `---BEGIN CERTIFICATE---` and ends with `---END CERTIFICATE---`.
      <Note>If you followed the manual process to use a PFX certificate instead of PEM, you must use a password-protected PFX. You also need to change the **SSL Client Cert Type** setting to **PFXBLOB** in the **Advanced Settings** tab of this screen.</Note>
    * **SSL Client Cert Password**—(optional) the password for the Client Cert, if it is encrypted. If it is not password-protected, leave this field blank.
  </Step>

  <Step>
    Set the **Use UAT** field according to your ADP configuration.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and ADP, see [this information page](https://cdn.cdata.com/help/JDJ/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# AWeber
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-AWeber-Embedded



## Prerequisites

Before you can add the connection, you must register an OAuth application with AWeber:

<Steps>
  <Step>
    Create a free AWeber developer account at [https://labs.aweber.com](https://labs.aweber.com).
  </Step>

  <Step>
    Log in to your developer account and create an app.
  </Step>

  <Step>
    After creating the app, copy the assigned **Client ID** and **Client Secret**. Store the client secret securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect AWeber to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *AWeber* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the AWeber developer portal.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the AWeber sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your AWeber account and grant the requested permissions.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# AfterShip
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Aftership-Embedded



## Prerequisites

Before you can add the connection, you must generate an API key from your AfterShip account:

<Steps>
  <Step>
    Log in to the AfterShip Account Portal and navigate to **Settings** > **API Keys** in the dashboard side menu.
  </Step>

  <Step>
    Click **Create API Key**, enter a name or description for the key, then choose your preferred signature header and configure admin API permissions.
  </Step>

  <Step>
    Click **Save** to generate the key.
  </Step>

  <Step>
    Copy the key immediately and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect AfterShip to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *AfterShip* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** from your AfterShip account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# AgileCRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-AgileCRM-Embedded



## Prerequisites

Before you can add the connection, you must obtain your REST API Key from your AgileCRM account:

<Steps>
  <Step>
    Log in to your AgileCRM account and go to **Admin Settings** > **API & Analytics**.
  </Step>

  <Step>
    Copy the **API Key** listed under **API Key for REST Clients**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect AgileCRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *AgileCRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain**, which is the subdomain of your AgileCRM account URL. For example, if your AgileCRM URL is *[https://yourcompany.agilecrm.com](https://yourcompany.agilecrm.com)*, the **Domain** is *yourcompany*.
  </Step>

  <Step>
    Set the **User** to your AgileCRM login email address.
  </Step>

  <Step>
    Set the **Password** to the REST API Key that you obtained in the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Aha!
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Aha-Embedded



## Prerequisites

Before you can use OAuth authentication, you must register an OAuth application in your Aha! account:

<Steps>
  <Step>
    Log in to your Aha! account and go to **Settings** > **Personal** > **Developer** > **OAuth Applications**.
  </Step>

  <Step>
    Enter a name for your application and set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Save**. Make note of the **Client ID** and **Client Secret**. Copy and store them securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Aha! to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Aha!* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain** for your Aha! account. For example, if your Aha! URL is *[https://yourcompany.aha.io](https://yourcompany.aha.io)*, enter *yourcompany*.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Aha!.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Aha! sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Aha! account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apify
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Apify-Embedded



## Prerequisites

Before you can add the connection, you must retrieve your API token from the Apify Console:

<Steps>
  <Step>
    Log in to the Apify Console and navigate to **Settings**.
  </Step>

  <Step>
    Generate a new API token and copy it. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Apify to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apify* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apollo
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Apollo-Embedded



## Prerequisites

Before you can add the connection, you need to register an OAuth application with Apollo:

<Steps>
  <Step>
    Log in to your Apollo account and go to **Settings** > **Integrations**.
  </Step>

  <Step>
    Locate the **API** option and click **Connect**.
  </Step>

  <Step>
    Click **OAuth registration** to open the registration form.
  </Step>

  <Step>
    Complete the required fields:

    * **App Name**–the name of your app or product.
    * **App Logo**–(optional) an image to display in the authorization prompt.
    * **OAuth Redirect URL**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
    * **Scopes**–select the permissions your app needs. Apollo automatically includes `read_user_profile` and `app_scopes`.
  </Step>

  <Step>
    Click **Submit** to register the app.
  </Step>
</Steps>

After registration, Apollo displays the **Client Id** and **Client Secret**. Make note of these values, since the Client Secret is only shown once.

## Setup Guide

Follow these steps to connect Apollo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apollo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Connect AI, enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Apollo.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Apollo sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Apollo account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Attio
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Attio-Embedded



## Prerequisites

Before you can add the connection, you must obtain an API key from your Attio account settings.

## Setup Guide

Follow these steps to connect Attio to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Attio* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from Attio.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Avaza
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Avaza-Embedded



## Prerequisites

Before you can add the connection, you must register an OAuth application with Avaza:

<Steps>
  <Step>
    Sign in to your [Avaza account](https://app.avaza.com) and go to **Settings** > **Manage Developer Apps** > **OAuth 2 Apps**.
  </Step>

  <Step>
    Click **Add OAuth App** and complete the required fields:

    * **Application Name**–the name of your application.
    * **Redirect URI**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save the application. Make note of the **Client ID** and **Client Secret**. In Connect AI, the Client ID is entered as the **OAuth Client Id** and the Client Secret as the **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Avaza to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Avaza* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Avaza.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Avaza sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Avaza account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# BambooHR
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-BambooHR-Embedded



## Prerequisites

Before you can add the connection, you need to generate an API key from your BambooHR account:

<Steps>
  <Step>
    Log in to BambooHR with a user that has sufficient permissions. The API key inherits the permissions of the user who creates it, so for full employee access, have an admin generate the key.
  </Step>

  <Step>
    Click your name in the lower-left corner of any page and select **API Keys** from the user context menu.
  </Step>

  <Step>
    Click **Add API Key**, give the key a name, and generate it.
  </Step>

  <Step>
    Copy the key immediately and store it securely. BambooHR only displays the key once.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect BambooHR to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *BambooHR* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Connect AI, enter the **Domain**, which is the subdomain of your BambooHR account URL (for example, if your BambooHR URL is *[https://yourcompany.bamboohr.com](https://yourcompany.bamboohr.com)*, the Domain is *yourcompany*).
  </Step>

  <Step>
    Enter the **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bannerbear
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Bannerbear-Embedded



## Prerequisites

Before you can add the connection, you must obtain an API key from your Bannerbear account. Bannerbear supports two key types:

* **Project key**: Scoped to a single project. Found in the project's **Settings** page.
* **Master key**: Provides access across all projects. Found in **Account Settings** under **API Key**.

Copy the key and store it securely.

## Setup Guide

Follow these steps to connect Bannerbear to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bannerbear* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    Set **Key Type** to **Project** or **Master**, depending on the key you are using.
  </Step>

  <Step>
    If you are using a Master key, enter the **Project Id** of the target project.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Benchmark Email
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-BenchmarkEmail-Embedded



## Prerequisites

Before you can add the connection, you must obtain an API key from your Benchmark Email account:

<Steps>
  <Step>
    Log in to the Benchmark Email Portal and click your username in the top-right corner of the dashboard.
  </Step>

  <Step>
    Select **Integrations** from the drop-down menu.
  </Step>

  <Step>
    Click **API Key** in the left-hand menu.
  </Step>

  <Step>
    Generate a new key or copy your existing key, then store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Benchmark Email to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Benchmark Email* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your Benchmark Email account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bitly
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Bitly-Embedded



## Prerequisites

Before you can add the connection, you must generate an access token from your Bitly account:

<Steps>
  <Step>
    Log in to your Bitly account at [https://bitly.com](https://bitly.com) and navigate to **Settings**, then **Developer Settings**.
  </Step>

  <Step>
    Click **Generate Access Token**. Copy the token. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Bitly to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bitly* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bright Data
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-BrightData-Embedded



## Prerequisites

Before you can add the connection, you must obtain an API key from your Bright Data account:

<Steps>
  <Step>
    Log in to the Bright Data Control Panel and navigate to **Account Settings** > **API**.
  </Step>

  <Step>
    Generate or copy your API key and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Bright Data to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bright Data* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Bright Data account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Campaigner
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Campaigner-Embedded



## Prerequisites

Before you can add the connection, you must generate an API key from your Campaigner account:

<Steps>
  <Step>
    Sign in to your Campaigner account and go to **Account Settings** > **Users**.
  </Step>

  <Step>
    Click **Create New User**.
  </Step>

  <Step>
    Under **User Role**, select **API User**, then click **Save**.
  </Step>

  <Step>
    An API key is generated for the new API user. Copy it and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Campaigner to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Campaigner* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** from your Campaigner account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Capsule CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-CapsuleCRM-Embedded



## Prerequisites

Before you can add the connection, you must register an OAuth application with Capsule CRM:

<Steps>
  <Step>
    Go to the [Capsule CRM developer portal](https://developer.capsulecrm.com/signIn) and sign in with your GitHub username and password.
  </Step>

  <Step>
    Click **Create New Application**.
  </Step>

  <Step>
    Enter a name for the application and set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save the application, then copy the **Client ID** and **Client Secret**. In Connect AI, these are entered as the **OAuth Client Id** and **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Capsule CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Capsule CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Capsule CRM.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Capsule CRM sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Capsule CRM account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# ClickUp
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Clickup-Embedded



## Prerequisites

Before you can add the connection, you must obtain a personal API token from ClickUp:

<Steps>
  <Step>
    Sign in to your [ClickUp account](https://app.clickup.com) and open your user settings.
  </Step>

  <Step>
    Navigate to the **Apps** section.
  </Step>

  <Step>
    At the top of the page, generate a personal token and copy it.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect ClickUp to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *ClickUp* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your personal token as the **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Close CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-CloseCRM-Embedded



## Prerequisites

Before you can add the connection, you must generate an API key from your Close CRM account:

<Steps>
  <Step>
    Log in to your Close CRM account and navigate to **Settings**, then **Your API Keys**.
  </Step>

  <Step>
    Click **New API Key**. Copy the generated key. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Close CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Close CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key** from the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Act! CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/ActCRM-Embedded



## Setup Guide

Follow these steps to connect Act! CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Act! CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Choose an **Act Edition** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Act CRM">
    <Steps>
      <Step>
        Enter the following information:

        * **Password**—the user password
        * **User**—the Act! CRM username for authentication
        * **URL**—the URL of the Act! CRM account
        * **Act Database**—the Act! database to which you want to connect
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Act Premium Cloud">
    <Steps>
      <Step>
        Enter the following information:

        * **Act Cloud Name**—the handle assigned to the Act! Premium Cloud account. You can find this in your web browser's address field when you open your Act! account. The form is similar to `https://eup1-iis-04.eu.hosted.act.com/**ActCloudName**`. Enter only the Act cloud name, not the entire URL.
        * **Password**—the user password
        * **User**—the Act! CRM username for authentication
        * **URL**—the URL of the Act! CRM account
        * **Act Database**—the Act! database to which you want to connect
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Act! CRM, see [this information page](https://cdn.cdata.com/help/FTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Act-On
Source: https://docs.cloud.cdata.com/en/Data-Sources/ActOn-Embedded



## Setup Guide

Follow these steps to connect Act-On to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Act-On* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Act-On sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Act-On account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Act-On, see [this information page](https://cdn.cdata.com/help/OVM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# ActiveCampaign
Source: https://docs.cloud.cdata.com/en/Data-Sources/ActiveCampaign-Embedded



## Setup Guide

Follow these steps to connect ActiveCampaign to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *ActiveCampaign* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **API Key**—the API Key for your ActiveCampaign account. Find this in your account on the **Settings** page under the **Developer** tab. Each user in your ActiveCampaign account has their own unique API key.
    * **URL**—find this in your account on the **My Settings** page under the **Developer** tab. For example: `https://{yourAccountName}.api-us1.com`
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and ActiveCampaign, see [this information page](https://cdn.cdata.com/help/JUM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Active Directory
Source: https://docs.cloud.cdata.com/en/Data-Sources/ActiveDirectory-Embedded



## Setup Guide

Follow these steps to connect Active Directory to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Active Directory* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the Active Directory server into the **Server** field.
  </Step>

  <Step>
    Enter the port for connecting to the Active Directory server in the **Port** field.
  </Step>

  <Step>
    Enter the Active Directory username for authentication into **User**.
  </Step>

  <Step>
    Enter the user password.
  </Step>

  <Step>
    Enter the **Base DN**. Specifying a narrow base distinguished name limits the scope of searches and can increase performance.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Active Directory, see [this information page](https://cdn.cdata.com/help/CDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Acumatica
Source: https://docs.cloud.cdata.com/en/Data-Sources/Acumatica-Embedded



## Setup Guide

Follow these steps to connect Acumatica to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Acumatica* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the base **URL** of your Acumatica site.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Acumatica username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Select a **Schema**. By default, this is set to `REST` Contract-Based API. You can also select `OData` to use the OData API for Acumatica Generic Inquiries. See the [OData](/en/API/OData-Dashboard) page for more information.
      </Step>

      <Step>
        If using the `REST` API, enter your **Endpoint Name** and **Endpoint Version**. These values can be found under Endpoint Properties in the Web Services Endpoint form of your Acumatica ERP.
      </Step>

      <Step>
        If using the `Odata` API, enter your **Company** Name.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Acumatica account.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Acumatica account.
      </Step>

      <Step>
        Select a **Schema**. By default, this is set to `REST` Contract-Based API. You can also select `OData` to use the OData API for Acumatica Generic Inquiries.
      </Step>

      <Step>
        If using the `REST` API, enter your **Endpoint Name** and **Endpoint Version**. These values can be found under Endpoint Properties in the Web Services Endpoint form of your Acumatica ERP.
      </Step>

      <Step>
        If using the `Odata` API, enter your **Company** Name.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Acumatica sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Acumatica account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Acumatica, see [this information page](https://cdn.cdata.com/help/OIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Adobe Analytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/AdobeAnalytics-Embedded



## Setup Guide

Follow these steps to connect Adobe Analytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Adobe Analytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        (Optional) Enter your **Global Company Id**. If left blank, the connection uses the first Company Id found.
      </Step>

      <Step>
        (Optional) Enter your Report Suite Id in the **RSID** field. To find your Report Suite Id, navigate to **Admin** > **Report Suites**. If left blank, the connection tries to detect it automatically.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Adobe Analytics sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Adobe Analytics account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Follow the steps below to create a custom app and obtain the connection properties to enter in this section.

        a. Navigate to the following URL: [https://console.adobe.io/home](https://console.adobe.io/home).

        b. Click the **Create new project** button.

        c. Select the **Add API** option.

        d. Select **Adobe Analytics**, click **Next**, and then select **OAuth** and then click **Next** again.

        e. Select the **Web** option and supply the URL of the page to redirect to (*[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*).

        f. Click **Save configured API**.

        Your client is now created. Note that your client has a Client ID (API Key) and a Client Secret. These are added in the next step.
      </Step>

      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your Adobe Analytics account for OAuth.
        * **OAuth Client Secret**—the client secret assigned when you registered your Adobe Analytics account for OAuth.
        * **Global Company Id**—(optional) your company identifier. If left blank, the connection uses the first Company Id found.
        * **RSID**—(optional) your report suite identifier. To find your RSID, navigate to **Admin** > **Report Suites**. If left blank, the connection tries to detect it automatically.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Adobe Analytics, see [this information page](https://cdn.cdata.com/help/SCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Adobe Commerce
Source: https://docs.cloud.cdata.com/en/Data-Sources/AdobeCommerce-Embedded



## Setup Guide

Follow these steps to connect Adobe Commerce to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Adobe Commerce* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Adobe Commerce username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password (for basic authentication).
      </Step>

      <Step>
        Fill in the **URL** field with the HTTP or HTTPS endpoint of your Adobe Commerce system (for example, `https://magentohost`).
      </Step>

      <Step>
        (Optional) Enter the **Store Code** for the store to which you want to connect. You need to enter a code in this field when more than one store is present in your Adobe Commerce system.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the Adobe Commerce **Access token**. See the [Adobe documentation](https://developer.adobe.com/commerce/webapi/get-started/authentication/gs-authentication-token/) for more information.
      </Step>

      <Step>
        Fill in the **URL** field with the HTTP or HTTPS endpoint of your Adobe Commerce system (for example, `https://magentohost`).
      </Step>

      <Step>
        (Optional) Enter the **Store Code** for the store to which you want to connect. You need to enter a code in this field when more than one store is present in your Adobe Commerce system.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Adobe Commerce, see [this information page](https://cdn.cdata.com/help/BZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Adobe Experience Manager
Source: https://docs.cloud.cdata.com/en/Data-Sources/AdobeExperienceManager-Embedded



## Setup Guide

Follow these steps to connect Adobe Experience Manager to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Adobe Experience Manager* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL**, which is the full WebDAV-enabled URL of your JCR Repository (for example, *[http://localhost:4503/crx/server](http://localhost:4503/crx/server)*).
  </Step>

  <Step>
    Enter your Adobe Experience Manager **User** and **Password**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>


# Adobe Target
Source: https://docs.cloud.cdata.com/en/Data-Sources/AdobeTarget-Embedded



## Prerequisites

Before you can add the connection, you must create an OAuth app in the Adobe Developer Console to obtain a Client ID and Client Secret:

<Steps>
  <Step>
    Navigate to [https://developer.adobe.com/console](https://developer.adobe.com/console) and sign in.
  </Step>

  <Step>
    Click **Create new project**.
  </Step>

  <Step>
    Select **Add API**, choose **Adobe Target**, and click **Next**.
  </Step>

  <Step>
    Select **OAuth Server-to-Server** and click **Next**.
  </Step>

  <Step>
    Select one or more product profiles to configure permissions and click **Save configured API**.
  </Step>

  <Step>
    Copy the **Client ID (API Key)** and **Client Secret**. Store them securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Adobe Target to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Adobe Target* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **OAuth Client Id**–the Client ID from your Adobe Developer Console project.
    * **OAuth Client Secret**–the Client Secret from your Adobe Developer Console project.
    * **Tenant**–the tenant name for your organization's Adobe Experience Cloud workspace.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Airtable
Source: https://docs.cloud.cdata.com/en/Data-Sources/Airtable-Embedded



## Setup Guide

Follow these steps to connect Airtable to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Airtable* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

By default, **Enable Metadata API** (in the **Advanced Settings** tab) is set to true. Enabling the Metadata API requires the 'schema.bases:read' scope for both PersonalAccessToken and OAuthPKCE authentication.

## Authentication Methods

<Tabs>
  <Tab title="PersonalAccessToken">
    <Steps>
      <Step>
        Enter the Airtable Personal Access Token in the **OAuth Access Token** field. To obtain the token, log in to your [Airtable user account](https://airtable.com/), navigate to the token creation page, and click **Create new token**. Add all the workspaces and bases that you want the token to have access to. Copy and save the generated token, as it will only be shown once.
      </Step>

      <Step>
        Enter your Airtable **Base Id**. The Base Id can be found in the [Airtable API Reference](https://airtable.com/api).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Enter your Airtable Base Id in the **Base Id** field. The Base Id can be found in the [Airtable API Reference](https://airtable.com/api).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Airtable, see [this information page](https://cdn.cdata.com/help/JAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# AlloyDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/AlloyDB-Embedded



## Setup Guide

Follow these steps to connect AlloyDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *AlloyDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the AlloyDB server in the **Server** field.
  </Step>

  <Step>
    In the **User** field, enter the AlloyDB username for authentication.
  </Step>

  <Step>
    Enter the user password in the **Password** field.
  </Step>

  <Step>
    (Optional) In the **Database** field, enter the name of the AlloyDB database to connect to. If this is left blank, the user's default database is used.
  </Step>

  <Step>
    (Optional) Enter the port for connecting to the AlloyDB server into the **Port** field.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and AlloyDB, see [this information page](https://cdn.cdata.com/help/KYJ/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon Athena
Source: https://docs.cloud.cdata.com/en/Data-Sources/AmazonAthena-Embedded



## Setup Guide

Follow these steps to connect Amazon Athena to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon Athena* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **S3 Staging Directory** that Amazon Athena uses to store the results of a query.
  </Step>

  <Step>
    Enter the Amazon Athena **Data Source**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSRootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        (Optional) Enter the **AWS External Id** only if emulating a different role.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        In **User** enter the Amazon Athena username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        In **User** enter the Amazon Athena username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL**.
      </Step>

      <Step>
        (Optional) Enter the **AWS Role ARN** only if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Amazon Athena account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Amazon Athena account for OAuth.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Enter the Amazon Athena **Database**. If this is blank, the default database set is used instead.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Amazon Athena sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Amazon Athena account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        In Amazon Athena, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Amazon Athena, see [this information page](https://cdn.cdata.com/help/FKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon DynamoDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/AmazonDynamoDB-Embedded



## Prerequisites

#### Whitelist CData IPs

To establish a connection to Amazon DynamoDB, you need to allow access to Amazon DynamoDB via CData’s IP. When hosting Amazon DynamoDB behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure Amazon DynamoDB Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect Amazon DynamoDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon DynamoDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL** to the URL use by the SSO provider.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        In Amazon DynamoDB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSRootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        In Amazon DynamoDB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        (Optional) Enter the **AWS External Id** only if emulating a different role.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        In Amazon DynamoDB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        In **User** enter the Amazon DynamoDB username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format ‘ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;’. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        In Amazon DynamoDB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        In **User** enter the Amazon DynamoDB username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format ‘ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;’. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL**.
      </Step>

      <Step>
        (Optional) Enter the **AWS Role ARN** only if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        In Amazon DynamoDB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Amazon DynamoDB, see [this information page](https://cdn.cdata.com/help/DDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon Marketplace
Source: https://docs.cloud.cdata.com/en/Data-Sources/AmazonMarketplace-Embedded



## Setup Guide

Follow these steps to connect Amazon Marketplace to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon Marketplace* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Marketplace** region in which you are registered.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Amazon Marketplace sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Amazon Marketplace account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Amazon Marketplace, see [this information page](https://cdn.cdata.com/help/ONM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon S3
Source: https://docs.cloud.cdata.com/en/Data-Sources/AmazonS3-Embedded



## Setup Guide

Follow these steps to connect Amazon S3 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon S3* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **AWS Region** that hosts your AWS account.
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Specify the **SSO Login URL** used by the identity provider.
      </Step>

      <Step>
        Enter the **SSO Properties** required to connect to the identity provider. Separate all property-value pairs with a semicolon.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSRootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** for your AWS account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Secret Key** for your AWS account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** for your AWS account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Secret Key** for your AWS account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the role to assume during authentication. To chain multiple roles, separate the ARNs with semicolons.
      </Step>

      <Step>
        (Optional) Enter the **AWS External Id** if you are assuming a role in another account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRolesAnywhere">
    <Steps>
      <Step>
        Enter the **AWS Role ARN** for the role to assume during authentication.
      </Step>

      <Step>
        Enter the **AWS Certificate**: either the absolute path to the certificate file or the certificate content in PEM format encoded in base64.
      </Step>

      <Step>
        Enter the **AWS Private Key**: either the absolute path to the private key file or the private key content in PEM format encoded in base64.
      </Step>

      <Step>
        Enter the **AWS Profile ARN** for the profile to pull policies from.
      </Step>

      <Step>
        Enter the **AWS Trust Anchor ARN** for the trust anchor to use for authentication.
      </Step>

      <Step>
        (Optional) Enter the **AWS Certificate Password** if your certificate is protected.
      </Step>

      <Step>
        (Optional) Enter the **AWS Private Key Password** if your private key is encrypted.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL** provided by Okta.
      </Step>

      <Step>
        Enter the **SSO Properties** required to connect to Okta. Separate all property-value pairs with a semicolon.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Keycloak">
    <Steps>
      <Step>
        Enter the **Keycloak Realm URL**: the full URL to your Keycloak server including the specific realm used for authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned to your OAuth application in Keycloak.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your OAuth application in Keycloak.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the PingFederate **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Specify the **SSO Login URL** used by the identity provider.
      </Step>

      <Step>
        Enter the **SSO Properties** required to connect to the identity provider. Separate all property-value pairs with a semicolon.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** used to consume the SAML response and exchange it for AWS credentials.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon S3 (Legacy)
Source: https://docs.cloud.cdata.com/en/Data-Sources/AmazonS3Sync-Embedded



## Setup Guide

Follow these steps to connect Amazon S3 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon S3* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the Name of the bucket containing the CSV, Parquet, or Avro files you are connecting to.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Specify the **SSO Login URL** used by the SSO provider.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Select the **File Format** to use.
      </Step>

      <Step>
        In Amazon S3, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSRootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Select the **File Format** to use.
      </Step>

      <Step>
        In Amazon S3, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account. You can find this on your AWS security credentials page.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        (Optional) Enter the **AWS External Id** only if emulating a different role.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Select the **File Format** to use.
      </Step>

      <Step>
        In Amazon S3, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        In **User** enter the Amazon S3 username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Select the **File Format** to use.
      </Step>

      <Step>
        In Amazon S3, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        In **User** enter the Amazon S3 username for authentication.
      </Step>

      <Step>
        In **Password** enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL**.
      </Step>

      <Step>
        Select the **AWS Region** that hosts your AWS account.
      </Step>

      <Step>
        Select the **File Format** to use.
      </Step>

      <Step>
        In Amazon S3, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Amazon S3, see [this information page](https://cdn.cdata.com/help/SXH/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Anaplan
Source: https://docs.cloud.cdata.com/en/Data-Sources/Anaplan-Embedded



## Prerequisites

Before connecting to Anaplan using the OAuth authentication method, you must create a custom OAuth application in Anaplan:

<Steps>
  <Step>
    Log in to Anaplan and navigate to **Home** > **Administration**.
  </Step>

  <Step>
    Click **OAuth Clients**.
  </Step>

  <Step>
    Click **New**.
  </Step>

  <Step>
    Enter a name for the OAuth client.
  </Step>

  <Step>
    Set the **Type** to **Authorization code grant**.
  </Step>

  <Step>
    Set the redirect URL to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Create client**.
  </Step>

  <Step>
    Note the **Client ID** and **Client Secret**. Use these values when configuring the connection in Connect AI.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Anaplan to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Anaplan* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Region** that corresponds to your Anaplan account's data hosting region.
  </Step>

  <Step>
    (Optional) Enter the **Catalog** to restrict the schema to only include objects from the specified catalog.
  </Step>

  <Step>
    (Optional) Enter the **Schema** to restrict the schema to only include objects from the specified schema.
  </Step>

  <Step>
    (Optional) Enter the **Bulk Timeout** to specify how long, in minutes, the provider waits for an Anaplan asynchronous job to complete before returning an error. The default value is 25 minutes.
  </Step>

  <Step>
    (Optional) Enter the **Bulk Polling Interval** to specify the maximum time interval, in milliseconds, between status checks for asynchronous jobs. The default value is 60000 milliseconds.
  </Step>

  <Step>
    (Optional) Enter the **Bulk Page Size** to specify the maximum number of records to process per page when reading asynchronous job results. The default value is 5000 records.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        For **OAuth Client Id**, enter the client ID from the prerequisites.
      </Step>

      <Step>
        For **OAuth Client Secret**, enter the client secret from the prerequisites.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User** (your Anaplan user email address).
      </Step>

      <Step>
        Enter the **Password** for your Anaplan account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Certificate">
    <Steps>
      <Step>
        Enter the **Certificate** in PEM format. This is the certificate used for certificate-based authentication.
      </Step>

      <Step>
        Set the **Certificate Type** to **PEM\_BLOB**.
      </Step>

      <Step>
        Enter the **Private Key** in PEM format. This is the private key associated with the certificate.
      </Step>

      <Step>
        Set the **Private Key Type** to **PEM\_BLOB**.
      </Step>

      <Step>
        (Optional) Enter the **Certificate Password** if the certificate is encrypted.
      </Step>

      <Step>
        (Optional) Enter the **Private Key Password** if the private key is encrypted.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache CouchDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApacheCouchDB-Embedded



## Setup Guide

Follow these steps to connect Apache CouchDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache CouchDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** used to connect to Apache CouchDB (for example, *[http://localhost:5984](http://localhost:5984)*).
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    **Basic** authenticates with a CouchDB user name and password.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the authenticating user's user ID.
        * **Password**—the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="JWT">
    **JWT** authenticates by signing a JSON Web Token that CouchDB validates against its configured keys.

    <Steps>
      <Step>
        Enter the following information:

        * **JWT Subject**—the user subject for which the application is requesting delegated access.
        * **JWT Algorithm**—the encryption algorithm used for signing the JWT. Supported values are **RS256**, **RS384**, **RS512**, **ES256**, **ES384**, **ES512**, **HS256**, **HS384**, and **HS512**. The default value is **RS256**.
        * **JWT Key Type**—the type of the encryption key used for signing the JWT. Supported values are **PEMKEY\_BLOB** and **SYMMETRIC**. The default value is **PEMKEY\_BLOB**.
        * **JWT Key**—the encryption key for signing the JWT.
        * **JWT Expiration**—(optional) the amount of time until the JWT expires, in seconds.
        * **JWT Headers**—(optional) a collection of extra HTTP headers to include in the JWT header.
        * **JWT Claims**—(optional) a collection of extra claims to include in the JWT payload.
        * **Credentials Location**—(optional) the filepath of the settings file containing the JWT. If a settings file does not exist in this location, the provider creates a new settings file when it retrieves a JWT.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    **None** is when no authentication is required. Use this option when querying public CouchDB databases.

    <Steps>
      <Step>
        Enter the **Public Databases**, which is a comma-separated list of public databases to list as tables.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Apache CouchDB, see [this information page](https://cdn.cdata.com/help/JCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache HBase
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApacheHBase-Embedded



## Setup Guide

Follow these steps to connect Apache HBase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache HBase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Server**—the host name, IP address, or URL of the server hosting Apache HBase. If there are multiple nodes, use the host name, IP address, or URL of the machine running the REST (Stargate) server.
    * **Port**—the port for the Apache HBase REST (Stargate) server. The default value is **8080**.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="None">
    **None** is when no authentication is required.

    <Steps>
      <Step>No additional settings are required for this authentication method.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    **Basic** is basic user name and password authentication.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the user who is authenticating to Apache HBase.
        * **Password**—the password used to authenticate to Apache HBase.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    If you set the **Auth Scheme** to **Negotiate**, the provider negotiates an authentication mechanism with the server. Use **Negotiate** if you want to use Kerberos for authentication.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the user who is authenticating to Apache HBase.
        * **Password**—the password used to authenticate to Apache HBase.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Apache HBase, see [this information page](https://cdn.cdata.com/help/RHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache Hive
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApacheHive-Embedded



## Setup Guide

Follow these steps to connect Apache Hive to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache Hive* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Transport Mode** to use for communicating with the Hive server: **HTTP** or **BINARY**.
  </Step>

  <Step>
    For HTTP transport mode only, enter the **HTTP Path**, available in the 'hive.server2.thrift.http.path' property of your Hive configuration file (hive.site.xml).
  </Step>

  <Step>
    Select an **Auth Scheme** for use in connecting to Apache Hive. Select the option that matches the configuration of the HiveServer2. Follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Plain">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Apache Hive username for authentication.
        * **Password**—the user password.
        * **Port**—the port for connecting to the Apache Hive server. If using HTTP transport mode, set **Port** to the value in the 'hive.server2.thrift.http.port' property of the Hive configuration file (hive.site.xml).
        * **Server**—the host name or IP address of the server hosting HiveServer2.
        * **Database**—(optional) the Apache Hive database to use. If left empty, the connection uses the default Apache Hive database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Apache Hive, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>

  <Tab title="LDAP">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Apache Hive username for authentication.
        * **Password**—the user password.
        * **Port**—the port for connecting to the Apache Hive server. If using HTTP transport mode, set **Port** to the value in the 'hive.server2.thrift.http.port' property of the Hive configuration file (hive.site.xml).
        * **Server**—the host name or IP address of the server hosting HiveServer2.
        * **Database**—(optional) the Apache Hive database to use. If left empty, the connection uses the default Apache Hive database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Apache Hive, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Apache Hive, see [this information page](https://cdn.cdata.com/help/FIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache Impala
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApacheImpala-Embedded



## Setup Guide

Follow these steps to connect Apache Impala to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache Impala* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Transport Mode** of **BINARY** or **HTTP**.
  </Step>

  <Step>
    Enter the following information:

    * **HTTP Path**—(HTTP transport mode only) the path component of the URL endpoint. The default value is "cliservice".
    * **User**—the Apache Impala username for authentication.
    * **Password**—the user password.
    * **Port**—the port for connecting to the Apache Impala server. For HTTP transport mode, this should be set to the value of the 'hs2\_http\_port' property of the Impala configuration (default: 28000).
    * **Server**—the name or network address of the SQL Server instance.
    * **Database**—(optional) the name of the Impala database to connect to. If not specified, the default database schema is used.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Apache Impala, see [this information page](https://cdn.cdata.com/help/GIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache Kafka
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApacheKafka-Embedded



## Setup Guide

Follow these steps to connect Apache Kafka to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache Kafka* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Bootstrap Servers** that the provider uses to establish the initial connection to the Apache Kafka cluster.
  </Step>

  <Step>
    (Optional) Toggle on **Use SSL** to have the provider negotiate SSL/TLS when connecting to the Apache Kafka broker.
  </Step>

  <Step>
    Select the **Type Detection Scheme**, which specifies how the provider determines the available fields and data types for each topic. Then proceed to the relevant section below.
  </Step>
</Steps>

## Type Detection Scheme

<Tabs>
  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this type detection scheme.</Step>

      <Step>
        Select the **Auth Scheme** that the provider uses when connecting to the Apache Kafka broker, then proceed to the next section.
      </Step>
    </Steps>
  </Tab>

  <Tab title="RowScan">
    <Steps>
      <Step>No additional settings are required for this type detection scheme.</Step>

      <Step>
        Select the **Auth Scheme** that the provider uses when connecting to the Apache Kafka broker, then proceed to next section.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SchemaRegistry">
    <Steps>
      <Step>
        Enter the **Registry URL**, which is the endpoint of the schema registry. When this property is specified, the provider supports reading Avro and JSON schemas from the server.
      </Step>

      <Step>
        Select the **Registry Service** that the provider uses to retrieve key and value schemas for Apache Kafka topics. Options are **Confluent** and **AWSGlue**.
      </Step>

      <Step>
        Select the **Registry Auth Scheme** that the provider uses when connecting to the schema registry. Options are **None**, **Basic**, and **SSLCertificate**. If you select **Basic**, also enter the **Registry User** and **Registry Password** used to authenticate to the schema registry.
      </Step>

      <Step>
        (Optional) Select the **Schema Merge Mode**, which specifies how the provider exposes schemas with multiple versions. Options are **None** and **Simple**.
      </Step>

      <Step>
        (Optional) Select the **Non Registry Type Detection Scheme**, which specifies the type detection scheme to use for topics that do not have schemas in the schema registry. Options are **Disabled**, **None**, **RowScan**, and **MessageOnly**.
      </Step>

      <Step>
        Select the **Auth Scheme** that the provider uses when connecting to the Apache Kafka broker, then proceed to the next section.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SchemaRegistryAggregate">
    <Steps>
      <Step>
        (Optional) Select the **Non Registry Type Detection Scheme**, which specifies the type detection scheme to use for topics that do not have schemas in the schema registry. Options are **Disabled**, **None**, **RowScan**, and **MessageOnly**.
      </Step>

      <Step>
        Select the **Auth Scheme** that the provider uses when connecting to the Apache Kafka broker, then proceed to the [Authentication](#authentication) section.
      </Step>
    </Steps>
  </Tab>

  <Tab title="MessageOnly">
    <Steps>
      <Step>No additional settings are required for this type detection scheme.</Step>

      <Step>
        Select the **Auth Scheme** that the provider uses when connecting to the Apache Kafka broker, then proceed to the next section.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Authentication

<Tabs>
  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this authentication scheme.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Plain">
    <Steps>
      <Step>
        Enter the **User**, which is the username used to authenticate to the Apache Kafka broker.
      </Step>

      <Step>
        Enter the **Password** used to authenticate to Apache Kafka.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SCRAM">
    <Steps>
      <Step>
        Enter the **User**, which is the username used to authenticate to the Apache Kafka broker.
      </Step>

      <Step>
        Enter the **Password** used to authenticate to Apache Kafka.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SCRAM-SHA-512">
    <Steps>
      <Step>
        Enter the **User**, which is the username used to authenticate to the Apache Kafka broker.
      </Step>

      <Step>
        Enter the **Password** used to authenticate to Apache Kafka.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Kerberos">
    <Steps>
      <Step>
        Enter the **Kerberos SPN**, which is the full Kerberos service principal name (SPN) of the Apache Kafka broker.
      </Step>

      <Step>
        Enter the **Kerberos Service Name** used when authenticating to the Apache Kafka broker.
      </Step>

      <Step>
        (Optional) Enter the **Kerberos Keytab File**, which is the path to the keytab file that contains the Kerberos principals and encrypted keys used for authentication.
      </Step>

      <Step>
        (Optional) Toggle on **Use Kerberos Ticket Cache** to use the Kerberos ticket cache for authentication instead of a keytab file.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SSLCertificate">
    <Steps>
      <Step>
        Enter the **SSL Client Cert** used to authenticate with the Apache Kafka broker.
      </Step>

      <Step>
        Select the **SSL Client Cert Type**, which specifies the format of the SSL client certificate. Options are **JKSFILE**, **PFXFILE**, **PEMKEY\_FILE**, and **PEMKEY\_BLOB**.
      </Step>

      <Step>
        (Optional) Enter the **SSL Client Cert Password** used to decrypt the certificate provided in **SSL Client Cert**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="KafkaOAuthClient">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
      </Step>

      <Step>
        Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which identifies the Apache Kafka tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which identifies the Apache Kafka tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which identifies the Apache Kafka tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) ID.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**, which identifies the type of key store containing the JWT certificate. Options are **PFXBLOB**, **JKSBLOB**, **PEMKEY\_BLOB**, **PUBLIC\_KEY\_BLOB**, **SSHPUBLIC\_KEY\_BLOB**, **XMLBLOB**, **BCFKSBLOB**, and **GOOGLEJSONBLOB**.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**, which identifies the type of key store containing the JWT certificate. Options are **PFXBLOB**, **JKSBLOB**, **PEMKEY\_BLOB**, **PUBLIC\_KEY\_BLOB**, **SSHPUBLIC\_KEY\_BLOB**, **XMLBLOB**, **BCFKSBLOB**, and **GOOGLEJSONBLOB**.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSWorkloadIdentity">
    <Steps>
      <Step>
        Enter the **AWS Workload Identity Config**, which are the configuration properties to provide when using Workload Identity Federation via AWS.
      </Step>

      <Step>
        Enter the **Workload Pool Id**, which is the ID of your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Project Id**, which is the ID of the Google Cloud project that hosts your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Provider Id**, which is the ID of your Workload Identity Federation pool provider.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureWorkloadIdentity">
    <Steps>
      <Step>
        Enter the **Azure Workload Identity Config**, which are the configuration properties to provide when using Workload Identity Federation via Azure.
      </Step>

      <Step>
        Enter the **Workload Pool Id**, which is the ID of your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Project Id**, which is the ID of the Google Cloud project that hosts your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Provider Id**, which is the ID of your Workload Identity Federation pool provider.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Apache Kafka, see [this information page](https://cdn.cdata.com/help/SKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Apache Phoenix
Source: https://docs.cloud.cdata.com/en/Data-Sources/ApachePhoenix-Embedded



## Setup Guide

Follow these steps to connect Apache Phoenix to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Apache Phoenix* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **URL**—the URL to your Apache Phoenix Query Server (PQS), for example *[http://phoenix-host:8765](http://phoenix-host:8765)*. When load balancing is configured, you can enter multiple URLs in a comma-separated list (for example, *URL1*, *URL2*, *URL3*).
    * **Version**—(optional) the version of the Apache Phoenix instance. The default value is **4.9.0**.
    * **Load Balance Strategy**—(optional) select the load balancing strategy used by the client-side load balancer (**None**, **Random**, **RoundRobin**, or **ShuffledRoundRobin**). The default value is **None**.
    * **Database Product Name**—(optional) select the name of the database product exposed by the Avatica server. The default value is **Auto** (the value is retrieved dynamically from the Avatica server).
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="None">
    **None** is when no authentication is required.

    <Steps>
      <Step>No additional settings are required for this authentication method.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    **Basic** is basic user name and password authentication.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Apache Phoenix user ID for authentication.
        * **Password**—the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    If you set the **Auth Scheme** to **Negotiate**, the provider negotiates an authentication mechanism with the server. Use **Negotiate** if you want to use Kerberos for authentication.

    <Steps>
      <Step>
        No additional settings are required for this authentication method.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureHDInsight">
    **AzureHDInsight** authenticates to an Apache Phoenix instance running on an Azure HDInsight cluster.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the HDInsight cluster username for authentication.
        * **Password**—the user password.
        * **Cluster Name**—the name of the cluster containing your Azure HDInsight instance.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Apache Phoenix, see [this information page](https://cdn.cdata.com/help/UAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Asana
Source: https://docs.cloud.cdata.com/en/Data-Sources/Asana-Embedded



## Setup Guide

Follow these steps to connect Asana to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Asana* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Asana sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Asana account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Asana, see [this information page](https://cdn.cdata.com/help/UJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Authorize.net
Source: https://docs.cloud.cdata.com/en/Data-Sources/AuthorizeNet-Embedded



## Setup Guide

Follow these steps to connect Authorize.net to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Authorize.net* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication

<Steps>
  <Step>
    Enter the **Login ID**, which is the Authorize.net API login Id associated with your payment gateway account.
    <Note>This value is not the same as the login Id that you use to log in to the Merchant Interface.</Note>
  </Step>

  <Step>
    Enter the **Transaction Key**, which is the Authorize.net transaction key associated with your payment gateway account.
  </Step>

  <Step>
    (Optional) Set **Use Sandbox** if you are using a Sandbox account. The provider makes requests to the production environment by default.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Authorize.net, see [this information page](https://cdn.cdata.com/help/CWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Avalara
Source: https://docs.cloud.cdata.com/en/Data-Sources/Avalara-Embedded



## Setup Guide

Follow these steps to connect Avalara to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Avalara* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Avalara username for authentication into **User**.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="LicenseKey">
    <Steps>
      <Step>
        Enter the **Account Id** of your Avalara account. The Account Id is located in the upper-right corner of the Avalara admin console.
      </Step>

      <Step>
        Enter the **License Key** generated by an account administrator on the Avalara website. To generate a license key:

        a. Log in to Avalara as an account administrator.

        c. Select **Settings**.

        b. Select **Reset License Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Avalara, see [this information page](https://cdn.cdata.com/help/GEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Avro
Source: https://docs.cloud.cdata.com/en/Data-Sources/Avro-Embedded



## Setup Guide

Follow these steps to connect Avro to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Avro* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI** for the Avro resource location.
  </Step>

  <Step>
    (Optional) Select the **Data Model** to use when parsing Avro documents. The default value is **None**.
  </Step>

  <Step>
    (Optional) Toggle **Aggregate Files** on if you want the provider to aggregate all the files in the URI directory into a single result.
  </Step>

  <Step>
    Select the **Connection Type**, which specifies the file storage service, server, or file access protocol through which your Avro files are stored and retrieved. Then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Connection Types

<Tabs>
  <Tab title="Amazon S3">
    <Steps>
      <Step>
        Select the **AWS Region** from the drop-down list. This is the hosting region for your Amazon Web Services.
      </Step>

      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme** to use when connecting to remote services. Then select the tab for your authentication scheme and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AwsRootKeys">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsEC2Roles">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsIAMRoles">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Role ARN**. This is the Amazon Resource Name of the role to use when authenticating.
          </Step>

          <Step>
            (Optional) Enter the **AWS External Id**. This is a unique identifier that might be required when you assume a role in another account.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsTempCredentials">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to AWS. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Session Token**. See the [AWS Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) for more information about the session token.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsCredentialsFile">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Keycloak">
        <Steps>
          <Step>
            Enter the **Keycloak Realm URL**. This specifies the full URL to the Keycloak server, including the specific realm used for authentication and authorization.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="EKSPodIdentity">
        <Steps>
          <Step>
            (Optional) Enter the **AWS Container Credentials Full URI**. This is the full URI of the container credential provider endpoint used by EKS Pod Identity.
          </Step>

          <Step>
            (Optional) Enter the **AWS Container Authorization Token File**. This is the path to a file containing the authorization token for the EKS Pod Identity credential provider.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Blob Storage">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2 SSL">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Files">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Box">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Dropbox">
    <Steps>
      <Step>
        (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTP">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTPS">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Google Cloud Storage">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Google Drive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS Secure">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTP">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTPS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="IBM Object Storage Source">
    <Steps>
      <Step>
        Enter the **Api Key** used to identify the user to the IBM Cloud.
      </Step>

      <Step>
        Enter the **Region**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from the security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneDrive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneLake">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Oracle Cloud Storage">
    <Steps>
      <Step>
        Enter the hosting **Region** for your S3-like Web Services.
      </Step>

      <Step>
        Enter the **Oracle Namespace**. This is the Oracle Cloud Object Storage namespace to use.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SFTP">
    <Steps>
      <Step>
        Select the **SSH Auth Mode**, which is the type of authentication to use when connecting to remote services. Then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Password">
        <Steps>
          <Step>
            Enter the **SSH User** used to authenticate to the SFTP server.
          </Step>

          <Step>
            Enter the **SSH Password** used to authenticate to the SFTP server.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Public_Key">
        <Steps>
          <Step>
            Enter the **SSH Client Cert**, which is the name of the certificate store for the client certificate.
          </Step>

          <Step>
            Select the **SSH Client Cert Type**, which is the type of key store containing the client certificate.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Password**. This is the password for the client certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Subject**. This is the subject of the SSH client certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the Avro tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint SOAP">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST V1">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure Data Catalog
Source: https://docs.cloud.cdata.com/en/Data-Sources/AzureDataCatalog-Embedded



## Prerequisites

The **AzureServicePrincipal** and **AzureServicePrincipalCert** authentication methods require a custom OAuth application registered in Microsoft Entra ID (formerly Azure AD). If you are connecting with the **AzureAD** method, you can skip this section.

To create and register a custom OAuth application in Entra ID, follow these steps:

<Steps>
  <Step>
    Sign in to the Azure portal and navigate to **Microsoft Entra ID > App registrations**, then click **New registration**.
  </Step>

  <Step>
    Enter a **Name** for the application.
  </Step>

  <Step>
    Under supported account types, select **Any Microsoft Entra ID tenant - Multitenant**, then click **Register**.
  </Step>

  <Step>
    On the application's overview page, record the **Application (client) ID** and the **Directory (tenant) ID**. You enter these values as the **OAuth Client Id** and the **Azure Tenant** in the setup steps below.
  </Step>

  <Step>
    Open **Certificates & Secrets** and add the credential for your chosen method:

    * For the **AzureServicePrincipal** method, select **New client secret**, specify a duration, and click **Add**. Record the secret value (shown only once); you enter it as the **OAuth Client Secret**.
    * For the **AzureServicePrincipalCert** method, select **Upload certificate** and upload your client certificate.
  </Step>

  <Step>
    Open the **Authentication** tab and enable the **Access tokens** option.
  </Step>

  <Step>
    Open **API permissions** and add **Azure Data Catalog > Delegated permissions > user\_impersonation**. Save your changes, then grant admin consent if your organization requires it.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Azure Data Catalog to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Data Catalog* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) Enter the **Catalog Name** of the catalog to connect to. The default is *defaultcatalog*.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which is the Azure Data Catalog tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Azure Data Catalog sign-in page in a new tab.
      </Step>

      <Step>
        Sign in to your Azure Data Catalog account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which is the Azure Data Catalog tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter your **OAuth Client Id** (also known as the consumer key) assigned when you registered your custom OAuth application.
      </Step>

      <Step>
        Enter your **OAuth Client Secret** assigned when you registered your custom OAuth application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **OAuth JWT Cert**, the name of the client certificate's JWT Certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**, the type of key store that contains the JWT Certificate. The default is *PEMKEY\_BLOB*.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Password** if the certificate store requires it.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Subject**. This is the subject of the OAuth JWT certificate. Supports partial matches and the wildcard '\*' to select the first certificate. If omitted, the first certificate in the certificate store is used.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Data Catalog, see [this information page](https://cdn.cdata.com/help/GNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure DevOps
Source: https://docs.cloud.cdata.com/en/Data-Sources/AzureDevOps-Embedded



## Setup Guide

Follow these steps to connect Azure DevOps to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure DevOps* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Organization** name. This is the segment of your Azure URL that follows the base URL, for example, [https://dev.azure.com/Organization\_Name](https://dev.azure.com/Organization_Name).
  </Step>

  <Step>
    Enter the **Catalog** to use.

    * If you want to query data for a specific project, set **Catalog** to either *Project\_projectId* or *Project\_projectName*. For example, to query data in a project named dev with the ID 2ee729d6-804d-4ece-84af-d5befa94abe8, you can set **Catalog** to either *Project\_dev* or *Project\_2ee729d6-804d-4ece-84af-d5befa94abe8*. To get a list of project IDs and names, execute a SELECT query against the Projects table.
    * Otherwise, enter *CData* to query information independent of a specific project.
  </Step>

  <Step>
    (Optional) Enter a **Schema**. If you are using the CData catalog, enter *Information* to access general Azure DevOps information not related to a specific project. Within any of the project catalogs, **Schema** can be set to *Project*, *Analytics*, or any of the repository schemas. To query data for a specific repository, set **Schema** to *Repository\_repositoryId*. Note that *Analytics* is read only.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Azure DevOps sign-in page in a new tab.
      </Step>

      <Step>
        Sign in to your Azure DevOps account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **Personal Access Token** generated in Azure DevOps.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure DevOps, see [this information page](https://cdn.cdata.com/help/HNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure Synapse
Source: https://docs.cloud.cdata.com/en/Data-Sources/AzureSynapse-Embedded



## Setup Guide

Follow these steps to connect Azure Synapse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Synapse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        Enter the following information:

        * The **User** and **Password** for Azure Synapse.
        * **Port**—the port for connecting to the Azure Synapse server.
        * **Server**—the host name or IP address of the Azure Synapse server.
        * **Database**—(optional) the name of the Azure Synapse database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the following information:

        * **Port**—the port for connecting to the Azure Synapse server.
        * **Server**—the host name or IP address of the Azure Synapse server.
        * **Database**—(optional) the name of the Azure Synapse database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant that you use to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Azure Synapse account for OAuth.
        * Either the **OAuth Client Secret** for your Azure Synapse account for OAuth OR the **OAuth JWT Cert** multi-line key in PEM format. Follow the format shown.
        * **Port**—the port for connecting to the Azure Synapse server.
        * **Server**—the host name or IP address of the Azure Synapse server.
        * **Database**—(optional) the name of the Azure Synapse database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Synapse, see [this information page](https://cdn.cdata.com/help/HEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Azure Table Storage
Source: https://docs.cloud.cdata.com/en/Data-Sources/AzureTables-Embedded



## Setup Guide

Follow these steps to connect Azure Table Storage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Table Storage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="SharedAccessSignature">
    <Steps>
      <Step>
        Enter the following information:

        * **Shared Access Signature**—a valid signature of a resource to connect to. This signature may be generated with a tool such as Azure Storage Explorer. See [Microsoft's help page](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview) for more information about shared access signatures.
        * **Account**—the Azure Storage account name. To access your Azure storage accounts or create one, log in to the Azure portal and click **Storage Accounts** in the services menu on the left. If the backend is set to **AzureStack**, set the Account as the complete host for your data. For example: `<account>.nm.azs.sandia.gov`. If the backend is set to **Emulator**, set the Account as the complete host. For example: `http://127.0.0.1:10002/devstoreaccount1`.
        * **Backend**—select the backend from the drop-down list. The backend is where the data is stored. Data may retrieved from the classic Azure Table Storage repository (**Storage**, the default), Azure Storage Emulator, CosmosDB, or Azure Stack Hub.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AccessKey">
    <Steps>
      <Step>
        Enter the following information:

        * **Account**—the Azure Storage account name. To access your Azure storage accounts or create one, log in to the Azure portal and click **Storage Accounts** in the services menu on the left. If the backend is set to **AzureStack**, set the Account as the complete host for your data. For example: `<account>.nm.azs.sandia.gov`. If the backend is set to **Emulator**, set the Account as the complete host. For example: `http://127.0.0.1:10002/devstoreaccount1`. To obtain the account name for the backend of **CosmosDB**, navigate to Cosmos DB service and select your Azure Cosmos DB Account. From the resource menu, go to the **Connection String** page. Find the account name and set the Account to this value.
        * **Access Key**—the key for the storage account. To obtain the Access Key for the default backend (**Storage**), log in to the Azure portal and click **Storage Accounts** in the services menu on the left to list the storage accounts. Select a storage account and click **Access Keys** in the **Settings** section. Either key1 or key2 can be used. To obtain the Access Key for the backend of **CosmosDB**, navigate to Cosmos DB service and select your Azure Cosmos DB Account. From the resource menu, go to the **Connection String** page. Find the PRIMARY KEY value and set the Access Key to this value.
        * **Backend**—select the backend from the drop-down list. Data may retrieved from the classic Azure Table Storage repository (**Storage**, the default), Azure Storage Emulator, CosmosDB, or Azure Stack Hub.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—(optional) the Microsoft Online tenant being used to access data. This value is the directory Id in **Azure Portal** > **Azure Active Directory** > **Properties**. If not specified, your default tenant is used.
        * **Account**—the Azure Storage account name. To access your Azure storage accounts or create one, log in to the Azure portal and click **Storage Accounts** in the services menu on the left. If the backend is set to **AzureStack**, set the Account as the complete host for your data. For example: `<account>.nm.azs.sandia.gov`. If the backend is set to **Emulator**, set the Account as the complete host. For example: `http://127.0.0.1:10002/devstoreaccount1`.
        * **Backend**—select the backend from the drop-down list. Data may retrieved from the classic Azure Table Storage repository (**Storage**, the default), Azure Storage Emulator, CosmosDB, or Azure Stack Hub.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Table Storage, see [this information page](https://cdn.cdata.com/help/CAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bcart
Source: https://docs.cloud.cdata.com/en/Data-Sources/BCart-Embedded



## Setup Guide

Follow these steps to connect Bcart to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bcart* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Personal Access Token** from Bcart.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Bcart, see [this information page](https://cdn.cdata.com/help/KGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Backlog
Source: https://docs.cloud.cdata.com/en/Data-Sources/Backlog-Embedded



## Setup Guide

Follow these steps to connect Backlog to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Backlog* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="APIToken">
    <Steps>
      <Step>
        Enter the following information:

        * **Api Key**—the API key that allows you to make requests to the Backlog API. You can generate this key by opening the Settings page in Backlog and selecting the **API** section.
        * **URL**—the URL of the Backlog account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the **OAuth Client Id** assigned when you registered your Backlog account for OAuth.
        * **OAuth Client Secret**—the client secret assigned when you register your Backlog account for OAuth.
        * **URL**—the URL of the Backlog account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Backlog, see [this information page](https://cdn.cdata.com/help/HOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Basecamp
Source: https://docs.cloud.cdata.com/en/Data-Sources/Basecamp-Embedded



## Setup Guide

Follow these steps to connect Basecamp to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Basecamp* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Account Id** of the authenticated Basecamp user. Your Basecamp URL contains the Account Id immediately after `basecamp.com`.
  </Step>

  <Step>
    Select a Basecamp **Schema** to use. Select **V2**, the Basecamp 2 API, or **V3**, the Basecamp 3 API.

    <Note>
      The **Basic** authentication scheme is only available in the **V2** schema.
    </Note>
  </Step>

  <Step>
    (Optional) Enter the **Project Id** of the authenticated Basecamp user. By default, the Project Id is first one on the projects list.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Basecamp sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Basecamp account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Note>
      Basic authentication is only available when connecting to Basecamp V2.
    </Note>

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the username of the currently authenticated user.
        * **Password**—the password of the currently authenticated user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Basecamp, see [this information page](https://cdn.cdata.com/help/BCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# BigCommerce
Source: https://docs.cloud.cdata.com/en/Data-Sources/BigCommerce-Embedded



## Setup Guide

Follow these steps to connect BigCommerce to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *BigCommerce* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your BigCommerce account for OAuth.
        * **OAuth Client Secret**—the client secret assigned when you registered your BigCommerce account for OAuth.
        * **Store Id**—this is located in the BigCommerce URL when you are logged in to your account. It is formatted as `https://store-[StoreId].mybigcommerce.com/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PersonalAccessToken">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Access Token**—To obtain the OAuth Access Token, log in to your BigCommerce account and do the following:
          1. Go to **Settings** > **Store-level API Tokens** > **+Create API Account**.
          2. Select **Token type** > **V2/V3 API Token**.
          3. Enter the name of your account (minimum of four characters).
          4. Choose the OAuth Scopes for the API Account you are creating. The driver cannot access data marked as "None" and cannot modify data marked as "read-only".
          5. Click **Save**. A successful save displays a pop-up window containing API credentials. Save your credentials, since you cannot return to this pop-up window.
        * **Store Id**—this is located in the BigCommerce URL when you are logged in to your account. It is formatted as `https://store-[StoreId].mybigcommerce.com/`. In BigCommerce, it is also known as the store hash.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and BigCommerce, see [this information page](https://cdn.cdata.com/help/UBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bing Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/BingAds-Embedded



## Setup Guide

Follow these steps to connect Bing Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bing Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Customer Id**. You can find this Id by logging into your Bing Ads account and navigating to the **Accounts and Billing** settings page. Your customer Id also appears as the final number in the Bing Ads URL when you are logged in (for example, `azure.bingads.microsoft.com/cc/AccountDetails?cid=123456789`).
  </Step>

  <Step>
    Enter your **Developer Token**. To get the token, log in to the [Bing Ads Developer Portal](https://developers.ads.microsoft.com/Account) as a Microsoft Account user with the **Bing Ads Super Admin** role. Then, click **Request Token**.
  </Step>

  <Step>
    (Optional) Enter your **Account Id**. This can be found in your Bing Ads account by navigating to the **Accounts and Billing** settings page. Then, click **Your Account**. If not specified, the connection automatically queries the first account found.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Bing Ads sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Bing Ads account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Bing Ads, see [this information page](https://cdn.cdata.com/help/EZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bitbucket
Source: https://docs.cloud.cdata.com/en/Data-Sources/Bitbucket-Embedded



## Prerequisites

Both the **OAuth** and **OAuthClient** authentication methods require a custom OAuth application (an OAuth consumer) created in Bitbucket.

To create an OAuth consumer, follow these steps:

<Steps>
  <Step>
    Sign in to Bitbucket and open the workspace you want to connect to.
  </Step>

  <Step>
    Navigate to **Settings > Workspace settings**, then under **Apps and features** select **OAuth consumers**.
  </Step>

  <Step>
    Click **Add consumer** and enter a **Name** for the consumer.
  </Step>

  <Step>
    In the **Callback URL** field, enter the Connect AI callback URL `https://oauth.cdata.com/oauth/`.
  </Step>

  <Step>
    Select the **Permissions** your application needs to access Bitbucket data.
  </Step>

  <Step>
    Save the consumer, then record the **Key** and **Secret**. You enter these values as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Bitbucket to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bitbucket* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) Enter the **Workspace**, the slug of the workspace to which to connect.
  </Step>

  <Step>
    (Optional) Enter the **Schema** to use. The available schemas are *Information*, the Repository schemas, and the Project schemas.
  </Step>

  <Step>
    (Optional) Enable **Include Deleted** to fetch deleted CommitComments and PullRequestComments records.
  </Step>

  <Step>
    Select your **Auth Scheme** and follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—Set to the Key (also known as the consumer key) assigned to your OAuth consumer.
        * **OAuth Client Secret**—Set to the Secret assigned to your OAuth consumer.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Bitbucket sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Bitbucket account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—Set to the Key (also known as the consumer key) assigned to your OAuth consumer.
        * **OAuth Client Secret**—Set to the Secret assigned to your OAuth consumer.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Box
Source: https://docs.cloud.cdata.com/en/Data-Sources/Box-Embedded



## Prerequisites (OAuth JWT Authentication Only)

Before you can establish a connection with Box with OAuth JWT authentication, you must create a custom OAuth application in the Box Developer Console.

<Steps>
  <Step>
    Log in to the [Box Developer Console](https://app.box.com/developers/console).
  </Step>

  <Step>
    Click **Create New App**.
  </Step>

  <Step>
    Specify basic application information, as appropriate.
  </Step>

  <Step>
    In **OAuth 2.0 Redirect URI**, add *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)* as a redirect URI.
  </Step>

  <Step>
    Click **Create App**.
  </Step>

  <Step>
    After you have an administrator authorize the app, select the scope of user permissions your custom OAuth app can request.
  </Step>

  <Step>
    After your application is created and registered, click **Configuration** from the main menu to access your settings. Note the **Client Id** and **Client Secret**. You will need these values to configure the connection in Connect AI.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Box to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Box* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Box sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Box account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned to your custom OAuth application (obtained in the prerequisites).
        * **OAuth Client Secret**—the client secret assigned to your custom OAuth application (obtained in the prerequisites). This value is used to authenticate the application to the OAuth authorization server.
        * **OAuth JWT Subject Type**—the subject type for the JWT authentication. Select **enterprise** to authenticate as the enterprise (service account) or **user** to authenticate as a specific user. The default value is **enterprise**.
        * **OAuth JWT Public Key Id**—the Id of the public key registered with your Box app for JWT authentication.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the following information:

        * **Subject Id**—the Id of the user or enterprise on whose behalf the application is requesting delegated access.
        * **Subject Type**—The subject type for the client credentials authentication. Select **enterprise** to authenticate as the enterprise or **user** to authenticate as a specific user. The default value is **enterprise**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Box, see [this information page](https://cdn.cdata.com/help/BBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Bullhorn CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/BullhornCRM-Embedded



## Setup Guide

Follow these steps to connect Bullhorn CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Bullhorn CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Data Center Code** where your account data is hosted. This code appears at the beginning of the Bullhorn CRM URL when you are logged in. For example, if your URL is `https://cls21.bullhornstaffing.com/BullhornSTAFFING/MainFrame.jsp`, your code is `CLS21`.
  </Step>

  <Step>
    Contact Bullhorn CRM to set up a custom OAuth application with the correct redirect URI for Connect AI, which is *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.

    <Note>
      Bullhorn CRM does not allow users to configure custom OAuth applications themselves. You must contact Bullhorn CRM for this step.
    </Note>
  </Step>

  <Step>
    After setting up your OAuth application, enter your **OAuth Client Id** and **OAuth Client Secret** in Connect AI.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Toggle **Include Custom Fields** on or off, depending on whether you want to include custom fields in the column listing.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Bullhorn CRM sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Bullhorn CRM account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the Bullhorn CRM username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Toggle **Include Custom Fields** on or off, depending on whether you want to include custom fields in the column listing.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Bullhorn CRM, see [this information page](https://cdn.cdata.com/help/HAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Business b-ridge
Source: https://docs.cloud.cdata.com/en/Data-Sources/Businessbridge-Embedded



## Setup Guide

Follow these steps to connect Business b-ridge to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Business b-ridge* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the required fields for authentication: **Company Key**, **Subscription Key**, and **Project Key**. To obtain the subscription key, log in to the Business b-ridge API portal and select **Your name** > **Profile**. In the subscription section, click **Main Key**.
  </Step>

  <Step>
    Enter the URL of your Business b-ridge account (optional). The URL is in the following format: `https://{account}.azure-api.net`.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Business b-ridge, see [this information page](https://cdn.cdata.com/help/HBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# 1010data
Source: https://docs.cloud.cdata.com/en/Data-Sources/C1010-Embedded



## Setup Guide

Follow these steps to connect 1010data to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *1010data* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Login URL** of your 1010data instance.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter your 1010data user ID in the **User** field.
      </Step>

      <Step>
        In **Password**, enter the user password.
      </Step>

      <Step>
        (Optional) Enter the **Group ID** of the SAM pool group to connect to, if using SAM pools.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        (Optional) Enter the **SSO Properties** with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="HTTPForm">
    <Steps>
      <Step>
        Enter your 1010data **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        (Optional) Enter the **SSO Properties** with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        (Optional) Enter the **SSO Properties** with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Cassandra
Source: https://docs.cloud.cdata.com/en/Data-Sources/Cassandra-Embedded



## Setup Guide

Follow these steps to connect Cassandra to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Cassandra* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Server**, which is the host name or IP address of the server hosting the Cassandra database.
  </Step>

  <Step>
    Enter the **Port** for the Cassandra database. The default port is 9042.
  </Step>

  <Step>
    (Optional) Enter the **Database**, which is the name of the Cassandra keyspace containing the tables.
  </Step>

  <Step>
    (Optional) Set **Use SSL** to enable SSL.
  </Step>

  <Step>
    (Optional) Select the **Consistency Level**, which determines how many of the replicas of the data you are interacting with need to respond for the query to be considered a success. The default is `ONE`.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="DSE">
    **DSE** authenticates against a DataStax Enterprise cluster.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Kerberos">
    **Kerberos** authenticates through a Kerberos ticket.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="LDAP">
    **LDAP** authenticates against an external LDAP server.

    <Steps>
      <Step>
        Enter the **LDAP Server**, which is the host name or IP address of the LDAP server.
      </Step>

      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        (Optional) Enter the **LDAP Port** for the LDAP server. The default port is 389.
      </Step>

      <Step>
        (Optional) Enter the **Default LDAP User** and **LDAP Password**. These must be set if the LDAP server does not allow anonymous bind.
      </Step>

      <Step>
        (Optional) Enter the **Search Base** for your LDAP server, used to look up users.
      </Step>

      <Step>
        (Optional) Enter the **Search Filter** for looking up usernames in LDAP. The default is `(uid=)`. When using Active Directory, set the filter to `(sAMAccountName=)`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Cassandra, see [this information page](https://cdn.cdata.com/help/RCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Cloudant
Source: https://docs.cloud.cdata.com/en/Data-Sources/Cloudant-Embedded



## Setup Guide

Follow these steps to connect Cloudant to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Cloudant* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the URL of your Cloudant instance.
  </Step>

  <Step>
    Select an **Auth Scheme** from the drop down.
  </Step>

  <Step>
    If you choose **Basic**, enter the following information:

    * **User**—the Cloudant username for authentication.
    * **Password**—the user password.
  </Step>

  <Step>
    If you choose **OAuth**, enter the IAM **API key**. See the [Cloudant documentation](https://cloud.ibm.com/Cloudant?topic=Cloudant-managing-access-for-cloudant) for more information.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>

  <Step>
    In Cloudant, add the Connect AI static IP addresses to your connection whitelist.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Cloudant, see [this information page](https://cdn.cdata.com/help/EWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Blackbaud Financial Edge NXT
Source: https://docs.cloud.cdata.com/en/Data-Sources/FinancialEdgeNXT-Embedded



## Prerequisites

Before you use the Blackbaud Financial Edge NXT connector, you must configure your own custom OAuth application via the Blackbaud SKY Developer Portal.

In your [SKY API Developer account](https://developer.blackbaud.com/):

<Steps>
  <Step>
    On the **My subscriptions** page, locate your subscription Id (primary access key).

    <Frame>
      <img alt="Blackbaud OAuth setup" />
    </Frame>
  </Step>

  <Step>
    On the **My applications** page, click **+New application** to configure a new OAuth application.
  </Step>

  <Step>
    In the **Add application** dialog, enter the information about the OAuth application as needed for your organization and click **Save**.

    <Frame>
      <img alt="Blackbaud add application" />
    </Frame>
  </Step>

  <Step>
    On the next page, do the following:

    * Add the CData redirect URI ([https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)).
    * Copy the OAuth **Client Id** and **Client Secret** to paste into Connect AI.
    * Edit **Scopes** to the desired level of data access.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Blackbaud Financial Edge NXT to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Blackbaud Financial Edge NXT* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Subscription Key**. Your subscription key can be found in your Blackbaud Financial Edge NXT profile.
  </Step>

  <Step>
    Paste the **Client Id** and **Client Secret** that you created in the prerequisites.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Blackbaud Financial Edge NXT sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Blackbaud Financial Edge NXT account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Certinia
Source: https://docs.cloud.cdata.com/en/Data-Sources/FinancialForce-Embedded



## Prerequisites

The **OAuth**, **OAuthClient**, **OAuthPassword**, and **AzureAD** authentication methods require a custom OAuth application. The default **OAuthPKCE** method uses CData's embedded OAuth application, so you can skip this section if you are using it.

To create a custom OAuth application in Certinia, follow these steps:

<Steps>
  <Step>
    Log in to your Salesforce org (the org where Certinia is installed) and navigate to **Setup**. In the **Quick Find** box, search for *Apps*, then click **New Connected App**.
  </Step>

  <Step>
    Enter a **Connected App Name** (the display name shown on the authentication dialog) and a **Contact Email**.
  </Step>

  <Step>
    Under **API (Enable OAuth Settings)**, select **Enable OAuth Settings** and set the **Callback URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Select the **OAuth scopes** that your application should request from the user, then **Save** the application.
  </Step>

  <Step>
    Open the connected app's settings to retrieve the **Consumer Key** (your **OAuth Client Id**) and **Consumer Secret** (your **OAuth Client Secret**). For the **OAuth**, **OAuthPassword**, and **AzureAD** methods, you enter these values in Connect AI when configuring the connection. The **OAuthClient** method requires the custom app to exist but provides no fields to enter these values.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Certinia to your Connect AI account:

<Steps>
  <Step>
    On the **Basic Settings** tab of the Certinia connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Certinia sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Certinia account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Certinia username for authentication.
      </Step>

      <Step>
        Enter the user **Password**.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Certinia sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Certinia account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        This method requires a custom OAuth application (see the [Prerequisites](#prerequisites) section), but there are no additional fields to complete in Connect AI.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the Certinia username for authentication.
      </Step>

      <Step>
        Enter the user **Password**.
      </Step>

      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        This authentication method requires no additional fields.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OneLogin">
    <Steps>
      <Step>
        Enter the OneLogin **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the Salesforce account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and then choosing the desired organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the PingFederate **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and then choosing the desired organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and choosing the desired organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and then choosing the desired organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and then choosing the desired organization.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Certinia sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Certinia account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Certinia, see [this information page](https://cdn.cdata.com/help/HFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google BigQuery
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleBigQuery-Embedded



## Prerequisites

In Google BigQuery, add the Connect AI static IP addresses to your connection whitelist.

## Setup Guide

Follow these steps to connect Google BigQuery to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google BigQuery* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Oauth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google BigQuery sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google BigQuery account.
      </Step>

      <Step>
        Click **Continue** to grant the requested permissions.

        <Note>
          Each permission is required for the connection to function.
        </Note>
      </Step>

      <Step>
        The **Project Id** field populates with your Google BigQuery project Ids. Select a project Id from the drop-down list or enter a custom value.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Oauth JWT">
    <Steps>
      <Step>
        In the **Project Id** field, enter the Google BigQuery project that you want to use.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert** provided by Google. This is a multi-line key.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Subject** if your services account is part of a GSuite domain and you want to enable delegation.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google BigQuery, see [this information page](https://cdn.cdata.com/help/DBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Blackbaud Raiser's Edge NXT
Source: https://docs.cloud.cdata.com/en/Data-Sources/RaiserEdgeNXT-Embedded



## Prerequisites

Before you use the Blackbaud Raiser’s Edge NXT connector, you must configure your own custom OAuth application via the Blackbaud SKY Developer Portal.

In your [SKY API Developer account](https://developer.blackbaud.com/):

<Steps>
  <Step>
    On the **My subscriptions** page, locate your subscription Id (primary access key).

    <Frame>
      <img alt="Blackbaud OAuth setup" />
    </Frame>
  </Step>

  <Step>
    On the **My applications** page, click **+New application** to configure a new OAuth application.
  </Step>

  <Step>
    In the **Add application** dialog, enter the information about the OAuth application as needed for your organization and click **Save**.

    <Frame>
      <img alt="Blackbaud add application" />
    </Frame>
  </Step>

  <Step>
    On the next page, do the following:

    * Add the CData redirect URI ([https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)).
    * Copy the OAuth **Client Id** and **Client Secret** to paste into Connect AI.
    * Edit **Scopes** to the desired level of data access.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Blackbaud Raiser's Edge NXT to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Blackbaud Raiser's Edge NXT* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Subscription Key**. This key is found in your BlackBaud Raiser's Edge NXT Profile, after subscribing to SKY API Standard Edition.
  </Step>

  <Step>
    Paste the **Client Id** and **Client Secret** that you created in the prerequisites.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Blackbaud Raiser's Edge NXT sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Blackbaud Raiser's Edge NXT account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Blackbaud Raiser’s Edge NXT, see [this information page](https://cdn.cdata.com/help/JZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Amazon Redshift
Source: https://docs.cloud.cdata.com/en/Data-Sources/Redshift-Embedded



## Prerequisites

#### Whitelist CData IPs

To establish a connection to Amazon Redshift, you need to allow access to Amazon Redshift via CData’s IP. When hosting Amazon Redshift behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure Amazon Redshift Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect Amazon Redshift to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Amazon Redshift* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the Amazon Redshift cluster into the **Server** field.
  </Step>

  <Step>
    Enter the Amazon Redshift **Database**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Amazon Redshift username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter the port for connecting to the Amazon Redshift server in the **Port** field.
      </Step>

      <Step>
        Enter the **AWS Principal ARN** to use during authentication if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        In Amazon Redshift, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the Amazon Redshift username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the port for connecting to the Amazon Redshift server in the **Port** field.
      </Step>

      <Step>
        Enter the **AWS Principal ARN** to use during authentication if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        In Amazon Redshift, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="IAMCredentials">
    <Steps>
      <Step>
        Enter the Amazon Redshift username for authentication in the **User** field.
      </Step>

      <Step>
        Enter your **AWS Access Key**.
      </Step>

      <Step>
        Enter your **AWS Secret Key**.
      </Step>

      <Step>
        Enter the port for connecting to the Amazon Redshift server in the **Port** field.
      </Step>

      <Step>
        Enter the **AWS Principal ARN** to use during authentication if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        In Amazon Redshift, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the Amazon Redshift username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL**.
      </Step>

      <Step>
        Enter the port for connecting to the Amazon Redshift server in the **Port** field.
      </Step>

      <Step>
        Enter the **AWS Principal ARN** to use during authentication if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        In Amazon Redshift, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the Amazon Redshift username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter the **OAuth Client Id** found in the Overview page of your Amazon Redshift application settings.
      </Step>

      <Step>
        Enter your **OAuth Client Secret**.
      </Step>

      <Step>
        Enter the **Scope**. For v1.0 OAuth tokens, this matches the **Scopes** field in the Expose of an API page of your OAuth app. For v2.0 OAuth tokens, it is the same as the app's Client Id.
      </Step>

      <Step>
        Enter the port for connecting to the Amazon Redshift server in the **Port** field.
      </Step>

      <Step>
        Enter the **AWS Principal ARN** to use during authentication if you have multiple Identity Providers in your AWS account.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Amazon Redshift sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Amazon Redshift account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        In Amazon Redshift, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Amazon Redshift, see [this information page](https://cdn.cdata.com/help/FRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Salesforce
Source: https://docs.cloud.cdata.com/en/Data-Sources/Salesforce-Embedded



## Required Prerequisites (Salesforce Admin Only)

<Steps>
  <Step>
    In a separate tab or browser window, log in to Salesforce.
  </Step>

  <Step>
    In Connect AI, open the **Sources** page of the navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Salesforce* into the search field, then click the data source name.
  </Step>

  <Step>
    Click **Save & Test** to test the connection. This results in an error message, but is necessary so that the CData connector appears in Salesforce. Ignore the error message.
  </Step>

  <Step>
    Go back to your Salesforce application. In **Salesforce Setup** (gear icon), navigate to **Apps** > **Connected Apps** > **Connected Apps OAuth Usage**.
  </Step>

  <Step>
    For the CData Connector, click **Install**. Salesforce displays an installation page.
  </Step>

  <Step>
    Click **Install** again to complete the process.
  </Step>
</Steps>

## Setup Guide

Return to Connect AI to continue connecting Salesforce to your Connect AI account:

<Steps>
  <Step>
    On the **Basic Settings** tab of the Salesforce connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Salesforce sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Salesforce account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Salesforce username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter a security token. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the Salesforce username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT certificate**. This is multi-line and in PEM format.
      </Step>

      <Step>
        Select the **OAuth JWT Certification type**.
      </Step>

      <Step>
        Enter the **OAuth JWT Issuer**. This must include the client\_id or connected app for the which the certificate is registered.
      </Step>

      <Step>
        (Optional) Enter an **OAuth JWT Cert Password** if the certificate. This only needs to be done if the certificate is encrypted.
      </Step>

      <Step>
        (Optional) If required, add an **OAuth JWT Cert Subject**.
      </Step>

      <Step>
        (Optional) If implementing for an Experience Cloud Site, an **OAuth JWT Subject** is required. It must be formatted as an email.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OneLogin">
    <Steps>
      <Step>
        Enter the OneLogin **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the PingFederate **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Add the **SSO Exchange URL** You can find this in the Salesforce account settings by navigating to **Administration Setup > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Salesforce account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Salesforce account for OAuth.
      </Step>

      <Step>
        Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Salesforce sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Salesforce account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Salesforce, see [this information page](https://cdn.cdata.com/help/RFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# au PAY Market
Source: https://docs.cloud.cdata.com/en/Data-Sources/auPAYMarket-Embedded



## Setup Guide

Follow these steps to connect au PAY Market to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *au PAY Market* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **API Key**—the API key from your au PAY Market store account.
    * **Shop Id**—the store account ID of your au PAY Market store.
  </Step>

  <Step>
    Set the **Use Sandbox** field to **True** (if you are connecting to a test environment). Otherwise, leave it as **False**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and au PAY Market, see [this information page](https://cdn.cdata.com/help/SWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Frequently Asked Questions (FAQs)
Source: https://docs.cloud.cdata.com/en/FAQs

This page provides answers to common questions about features and technical parameters of Connect AI.

<script type="application/ld+json" />

<AccordionGroup>
  <Accordion title="What is the rate limit for issuing requests to connections?">
    The Connect AI rate limit is 100 requests per user per minute for regular queries and 500 requests per user per minute for metadata queries. This limit is shared across all data sources, so if a user issues 70 requests in a minute to one connection, that user can only issue 30 more requests to another connection in the same minute. Note that requests with excessively long response times might time out. If your request times out, please refine the query to reduce the time it takes to execute.
  </Accordion>

  <Accordion title="What static IP addresses does Connect AI use?">
    Connect AI uses a range of static IP addresses to communicate with external data sources. To ensure that you can access your data, you must whitelist these static IP addresses in your data sources. The table below lists these IP addresses.

    | IP Addresses (CIDR) | IP Addresses (Range) |
    | :- | :- |
    | 52.224.0.160/28 | 52.224.0.160 - 52.224.0.175 |
    | 4.154.117.160/28 | 4.154.117.160 - 4.154.117.175 |
  </Accordion>

  <Accordion title="How do I change the email address on my account?">
    To change the primary contact for your Connect AI account, go to the **Settings** page (gear icon on the upper right), select the **Account** tab, and edit the email under **Primary Contact Information**. Note that this is where you receive account-related notifications. This is NOT the login email address.

    To change your login email, go to the **Settings** page, select the **Profile** tab, and edit the email under **Login**. Save your changes.
  </Accordion>

  <Accordion title="Why is my data not available in my integration tool?">
    First, check that you can access your data from your connection using [Data Explorer](/en/Data-Explorer). If you cannot, there may be an issue with the connection to your data source. Check your connection details and ensure that you have set the permissions for the connection correctly.

    If you can access your data in Data Explorer, there may be an issue with the configuration of your integration tool. Check your integration tool configuration according to the instructions in the [documentation](/en/Integrations-Embedded).

    If your data is still not accessible, please contact CData Technical Support.
  </Accordion>

  <Accordion title="Are there currently any known service outages?">
    The [Connect AI Status page](https://status.cdata.com/) shows the current status and incident history for the application services.
  </Accordion>

  <Accordion title="How do I contact CData Technical Support?">
    The [CData Technical Support](https://www.cdata.com/support/submit.aspx) contact form allows you to send a message to our Technical Support team. You also access this form by clicking the **Support** link at the bottom of the dashboard.
  </Accordion>
</AccordionGroup>


# Glossary
Source: https://docs.cloud.cdata.com/en/Glossary

The following table provides a set of standard terms that are used in the Connect AI documentation. Note that these definitions are applicable only within the context of Connect AI.

| Term | Definition |
| :- | :- |
| **Asset** | An identifiable piece of data that an organization owns. Data assets are useful to query and extract insights from. |
| **Audit log** | Records all non-query activity on your Connect AI account (for example, creating users and editing permissions). |
| **Connection** | A configured instance of a data source that is connected to a Connect AI account. |
| **Dashboard** | The command center for all Connect AI functions. The dashboard enables an administrator to connect and configure connections and users, download client connectors, read audit logs and query logs, access documentation, and view account information. |
| **Data source** | An application, API, or database to which Connect AI connects. A data source provides data to any supported integration tools. Examples of data sources include Salesforce and Amazon Athena. |
| **Integration tool** | An application or tool that connects to Connect AI and accepts inputs from connections for processing, analysis, manipulation, and more. Examples of integration tools include Google Sheets and Microsoft Power BI. |
| **Query log** | Records all queries that connected integration tools make to Connect AI. Detailed query logs are kept for seven days and then are deleted automatically. |
| **Workspaces** | Organizes your Connect AI data assets. A workspace can contain a single level of folders for organization. Inbound connections from other tools specify which workspace to connect to. |


# Integrations
Source: https://docs.cloud.cdata.com/en/Integrations-Embedded

The following are the integration tools available for Connect AI Embed:

### AI Tools

Below is a list of the Artificial Intelligence (AI) tools that connect to Connect AI Embed:

* [Claude Code](/en/Clients/ClaudeCode-Client-Embedded)
* [Codex](/en/Clients/Codex-Client-Embedded)
* [CrewAI](/en/Clients/CrewAI-Client-Embedded)
* [Cursor](/en/Clients/Cursor-Client-Embedded)
* [Gemini](/en/Clients/Gemini-Client-Embedded)
* [LangChain](/en/Clients/LangChain-Client-Embedded)
* [LangGraph](/en/Clients/LangGraph-Client-Embedded)
* [LlamaIndex](/en/Clients/LlamaIndex-Client-Embedded)
* [n8n](/en/Clients/N8N-Client-Embedded)
* [Replit Agent](/en/Clients/Replit-Client-Embedded)
* [Windsurf](/en/Clients/Windsurf-Client-Embedded)

### ETL Tools

Below is a list of the ETL tools that connect to Connect AI Embed:

* [CData Sync](/en/Clients/CDataSync-Client-Embedded)
* [Cloud Data Fusion](/en/Clients/CloudDataFusion-Client-Embedded)

### Dev Tools

Below is a list of the development tools that connect to Connect AI Embed:

* [ADO.NET](/en/Clients/ADO.NET-Client-Embedded)
* [JDBC](/en/Clients/JDBC-Client-Embedded)
* [Node.js](/en/Clients/Nodejs-Client-Embedded)
* [ODBC](/en/Clients/ODBC-Client-Embedded)
* [Python](/en/Clients/Python-Client-Embedded)
* [SSIS](/en/Clients/SSIS-Client-Embedded)


# Jobs
Source: https://docs.cloud.cdata.com/en/Jobs

The ***Jobs*** page enables you to manage and run various Connect AI jobs. From this page, you can manage either [Caching](/en/Caching) or [Scheduled Queries](/en/Scheduled-Queries).

<Frame>
  <img alt="Jobs" />
</Frame>

The **Connect AI caching feature** allows you to select tables to be cached, or saved to a database. Connect AI then fetches data for the selected tables on a scheduled basis, ensuring swift and reliable access to data whenever you need it.

Note that when you enable caching of data, Connect AI runs database queries against the *cached* data, not the live data. The cached data is stored in a PostgreSQL database, which you must set up before using the caching feature. You can set up the data warehouse for your cached data by clicking **Set Up Data Warehouse** on the Jobs page. This takes you to the **Add PostgreSQL Connection** page.

Once the data warehouse is set up, you can manage it by clicking **Manage Data Warehouse** at the top of the Jobs page. See [Caching](/en/Caching) for details.

The **Connect AI scheduled queries feature** allows you to write queries in Data Explorer and schedule them to write data to a variety of supported destinations based on a set schedule. Before you use the scheduled queries feature, you must set up a connection that contains the destination tables for the scheduled queries. See [Scheduled Queries](/en/Scheduled-Queries) for details.

The **Jobs** page contains the following information about each job:

* **Name**—the name of the job. For cached jobs, the job name is the table name. For scheduled queries, the job name is user defined.
* **Job Type**—The job type, which is either **Cache** or **Scheduled Query**.
* **Last Run**—The last time the job was run, and the next scheduled run.
* **Status**—The status of the job, which can be one of the following:
  * **Success**—the job completed successfully.
  * **Failed**—the job was unsuccessful. Click anywhere in the job to open the **Edit Job** page. **Edit Job** displays details about why the job failed.
  * **Running**—the job is in progress.
  * **Canceled**—the user canceled the job.
  * **Queued**—the job is queued to run at the time specified in Next Run.
    The toggle switch in the **Status** column indicates whether the job is enabled or disabled. You can disable a job temporarily without deleting it.
* **Job Actions**—The icons in the last column represent the various actions you can perform on a job.
  * **Run (▷)**—Run the selected job immediately. You can run several jobs at once by selecting the jobs to run and clicking the **Run** button on the top of the page.
  * **Edit (🖉)**—Edit the selected job in the **Edit Job** page.
  * **Delete (🗙)**—Delete the selected job. You can delete several jobs at once by selecting the jobs to delete and clicking the **Delete** button at the top of the page.

Click **+Add Job** to add a new cache job or scheduled query. Note that you cannot add a cache job until you set up the data warehouse.

### Filtering

The section above the jobs table allows you to filter jobs by name, job type, last run, and/or status.

* **Name**—displays only jobs matching the job name.
* **Job Type**—select whether to display only cached jobs or only scheduled queries.
* **Last Run**—displays only jobs that were last run in the given date range (such as the last 7 days) or a custom date range selected from the date picker.
* **Status**—displays only jobs that have a certain status (success, failed, running, canceled, or queued).

Click **Apply** to apply the selected filter(s) to the jobs table and perform a search. Click **Clear all** to start over.


# Logs
Source: https://docs.cloud.cdata.com/en/Logs-Embedded

The ***Logs*** page in the navigation menu consists of two tabs:

* **Query Log**—the query log contains details about the queries that are made to your Connect AI Embed account.
* **Audit Log**—the audit log records administrative events, including user login, permission changes, and more.

## Query Log

The **Query Log** tab displays a list of performed queries and the following information for each one:

* **Timestamp**—the time when the query occurs, formatted as *YYYY*-*MM*-*DD* *HH*:*MM*:*SS* AM/PM UTC.
* **Query Type**—the category of the query.
* **Account**—the account Id of the Connect AI Embed sub-account that made the query.
* **Status**—the final state of the query; that is, whether it succeeded or failed.
* **Query Text**—the text and destination of the query.

<Frame>
  <img alt="Query Log" />
</Frame>

At the bottom of the query table, you can select the number of queries to display per page and you can navigate among pages of results.

### Query Details

Clicking any query in the log expands the query and displays detailed information about it. The fields and contents can vary among queries of different types.

<Frame>
  <img alt="Query Details" />
</Frame>

You can click the **Logs** button in a query details section to download a log file that contains details about the query. These log files are useful in troubleshooting errors that are related to issuing queries to Connect AI Embed.

<Note>
  **Notes:**

  * You can increase or decrease the logging verbosity for a connection on the **Advanced Settings** page for that connection. The default verbosity is 2. See [Data Sources](/en/Data-Sources#logging-verbosity) for more information.
  * Connect AI Embed saves log files for seven days only. Log files older than seven days are deleted automatically.
</Note>

### Filtering

The section above the query table allows you to filter queries by such properties as date range, query type, account Id, status, and query Id.

* **Date Range**—displays only queries that match the given date range (such as the last 7 days) or a custom date range selected from the date picker.
* **Query Type(s)**—displays only queries of the type(s) that you select.
* **Account**—displays only queries that were performed by the specified sub-account. Leave empty to select all sub-accounts.
* **Status**—displays only queries that were a success or that failed.
* **Query Text or Query Id**—displays only queries that include the entered text or match the Query Id.

<Frame>
  <img alt="Query Filter" />
</Frame>

Click **Apply** to apply the selected filter(s) to the query table and perform a search. Click **Clear all** to start over.

## Audit Log

The **Audit Log** tab displays a list of audit events and the following information for each event:

* **Timestamp**—the time when the event occurs, formatted as *YYYY*-*MM*-*DD* *HH*:*MM*:*SS* AM/PM UTC.
* **Event Type**—the category of audit event.
* **Account**—the account Id of the Connect AI Embed sub-account that triggered the event.
* **Target Resource**—the category and the name of the targeted resource.

<Frame>
  <img alt="Audit Log" />
</Frame>

At the bottom of the audit table, you can select the number of events to display per page and navigate among pages of results.

### Audit Details

Clicking any event in the audit log expands the event and displays detailed information about it. The fields and content can vary among events of different types. Some events do not have any detailed information to display.

<Frame>
  <img alt="Audit Details" />
</Frame>

### Filtering

The section above the audit log enables you to filter events by date range, event type(s) and account Id.

* **Date Range**—displays only events that match the given date range (such as last 7 days) or a custom date range selected from the date picker.
* **Event Type**—displays only events of the type(s) that you select.
* **Account**—displays only events that were triggered by the specified account Id.

<Frame>
  <img alt="Audit Filter" />
</Frame>

Click **Apply** to apply the selected filter(s) to the audit log table and perform a search. Click **Clear all** to start over.


# Navigation Menu
Source: https://docs.cloud.cdata.com/en/Navigation-Embedded

The navigation menu serves as the configuration center for Connect AI Embed and its sub-accounts. When you log in, the **Dashboard** page displays.

<Frame>
  <img alt="Navigation menu" />
</Frame>

Click the name of a section in the list below for more details about that section of Connect AI Embed:

* **[Dashboard](/en/Dashboard-Embedded)** provides a concise view of information for connections and queries.
* **[Sources](/en/Sources-Embedded)** displays a read-only list of sources your sub-accounts are connected to.
* **[Integrations](/en/Integrations-Embedded)** provides assistance with connecting integration tools to Connect AI Embed.
* **[Accounts](/en/Accounts-Embedded)** enables you to create and manage sub-accounts.
* **[Users](/en/Users-Embedded)** enables you to invite and manage users.
* **[Logs](/en/Logs-Embedded)** contains detailed logs for your Connect AI Embed account.
* **[API](/en/API/API-Embedded)** provides documentation for connecting to data via the REST API.
* **[Documentation](/en/docs-Embedded)** is a link to the home page of the documentation.

The top navigation bar of Connect AI Embed contains the following items:

* A clickable icon that toggles the display of the left-pane navigation menu:
  <Frame>
    <img alt="Menu collapse" />
  </Frame>
* A Question Mark icon, which opens this documentation to the **[Getting Started](/en/docs-Embedded)** page.
* A Gear Icon, which opens your Connect AI Embed **[Settings](/en/Settings-Embedded)**.
* Your username, which you can click to open a drop-down menu that allows you to **Sign out**.


# CData Connect AI Privacy Policy
Source: https://docs.cloud.cdata.com/en/Privacy-Policy



*Effective Date: March 16, 2026*

This Privacy Policy describes how CData Software, Inc. ("CData," "we," "us," or "our") collects, uses, and shares information when you use CData Connect AI, CData’s enterprise platform for governed AI agent data access ("Connect AI"). It also describes your rights and choices.

### What We Collect

**Information you provide to us.** When you create or administer a Connect AI account, we collect your name, email address, company name, and billing contact information.

**Configuration and connection information.** When you set up Connect AI to connect your third-party data sources, we store the configurations, credentials, and access tokens needed to make those third-party connections work on your behalf.

**Usage information.** We collect records of how you use Connect AI—including which tools/APIs were called, by which agents or integrations, and when—to support your audit and compliance needs and to keep the platform running reliably.

**Communications.** If you contact us for support or by email, we keep a record of that contact information and correspondence.

### How We Use Your Information

We use the information we collect to:

* Provide, operate, and maintain Connect AI

* Enforce the access control policies you configure for your AI agents and integrations

* Give you audit logs and observability into what your agents are accessing

* Send you platform notifications, security alerts, and billing communications

* Respond to your questions and support requests

* Comply with legal obligations

We do not use your data to train AI models. We do not sell your data or share it with advertisers.

### How We Share Your Information

We do not sell personal data. We share information only in these circumstances:

**Service providers.** We work with third-party vendors who help us operate the platform (such as cloud infrastructure and payment processing). These vendors have contracts in place with CData that require them to protect your data. They may only use your data to provide services to us.

**Your organization.** Administrators in your organization can access usage logs and configurations for users and agents within your account. Your data is not accessible to other organizations using Connect AI.

**Legal requirements.** We may disclose certain information of yours if required by law, court order, or to protect the safety or rights of CData, our customers, or others. Where permitted, we will notify you before doing so.

**Business transfers.** If CData is involved in a merger or acquisition, your information may be transferred as part of that transaction. We will notify you in the event your data becomes subject to a different privacy policy.

### Your Data and AI Agents

Connect AI sits between your AI agents or applications and your enterprise data sources. Here are the details about how your data flows through Connect AI:

When an AI agent or integration makes a request through Connect AI, the query result is processed and returned directly to the agent. That query and query result may be stored temporarily within Connect AI for processing, for up to 24 hours. CData does not use, and does not authorize our service providers to use your data to train AI models. CData does not share your data with other Connect AI customers.

You control what your agents can access through the access policies you configure within Connect AI. Connect AI is configured to enforce those policies as it executes your requests.

### Data Retention

CData keeps account and configuration data associated with your license for the duration of your subscription and for 30 days after expiration or termination of your subscription. After that time, your data is deleted. CData retains query logs associated with your account for 60 days, audit logs for 6 months, and detailed log files are kept for 7 days. If you delete your account, your data is purged within 30 days of the date of deletion.

You can delete your account and manually purge all data yourself from within the Connect AI dashboard at any time.

### Your Rights and Choices

Depending on where you live, you may have the right to access, correct, delete, or export your personal data, or to object to certain processing. To make a request, contact us using the intake form on the CData website.

If you are in the EU or UK and believe your privacy rights have not been respected, you have the right to lodge a complaint with your local data protection authority.

### International Transfers

CData is based in the United States. If you access Connect AI from outside the US, your data may be processed in the United States or other countries where we or our service providers operate.

### Changes to This Policy

We may update this policy from time to time. When we make material changes, we will notify you by email or through the platform before the change takes effect and will update the effective date at the top of this page.

### Contact Us

CData Software, Inc., 101 Europa Drive, Suite 110, Chapel Hill, NC 27517

[privacy@cdata.com](mailto:privacy@cdata.com)

*For enterprise customers with a Data Processing Addendum (DPA) in place, the terms of the DPA also apply, and the DPA governs in the event of any conflict with this policy.*


# Private Cloud Connector
Source: https://docs.cloud.cdata.com/en/Private-Cloud-Connector

The Private Cloud Connector feature of Connect AI is software you install in an on-premises network. The connector acts as a bridge between your on-premises data (not in the cloud) and Connect AI.

The Private Cloud Connector is an on-premises connector, which you can run as a Docker container or deploy to Kubernetes via Helm. The connector acts as a secure reverse tunnel between the data behind your company's firewall, private network, or Virtual Private Cloud (VPC) and the Connect AI cloud-based services. It allows Connect AI to access your data without exposing your data directly to the internet.

<Frame>
  <img alt="Private Cloud Connector Architecture" />
</Frame>

You then register each connector in the Connect AI user interface, within the individual connection setup. You can have connectors in multiple locations. You must register a connector in Connect AI for each location.

The Private Cloud Connector provides high availability by supporting multiple connector instances—either multiple Docker containers, or replicas in a Kubernetes deployment—pointing to the same location and account Id. If one instance goes down, requests are automatically routed to the remaining connector instances.

The following diagram shows how Private Cloud Connector supports multiple locations and multiple data sources.

<Frame>
  <img alt="Private Cloud Connector Architecture Advanced" />
</Frame>

The following is a list of some of the connectors that Connect AI supports with the Private Cloud Connector:

* [API](/en/Data-Sources/APIConnector)
* [Confluence](/en/Data-Sources/Confluence)
* [Databricks](/en/Data-Sources/Databricks)
* [GitHub](/en/Data-Sources/GitHub)
* [Jira](/en/Data-Sources/JIRA)
* [MySQL](/en/Data-Sources/MySQL)
* [PostgreSQL](/en/Data-Sources/PostgreSQL)
* [QuickBooks](/en/Data-Sources/QuickBooks)
* [SAP Business One](/en/Data-Sources/SAPBusinessOne)
* [SAP Gateway](/en/Data-Sources/SAPGateway)
* [Snowflake](/en/Data-Sources/Snowflake)
* [Splunk](/en/Data-Sources/Splunk)
* [SQL Server](/en/Data-Sources/SQL)

Contact [CData Support](https://www.cdata.com/support/submit.aspx) if you need a different connector with the Private Cloud Connector.

Setting up the Private Cloud Connector involves three main steps:

<Steps>
  <Step>
    [Register the Private Cloud Connector in Connect AI](#register-the-private-cloud-connector-in-connect-ai).
  </Step>

  <Step>
    Install and run the connector in each location where your on-premises data is located. You can either [deploy the Private Cloud Connector with Docker](#deploy-the-private-cloud-connector-with-docker) or [deploy the Private Cloud Connector on Kubernetes](#deploy-the-private-cloud-connector-on-kubernetes).
  </Step>

  <Step>
    [Finish the Private Cloud Connector setup](#finish-private-cloud-connector-setup) in Connect AI to test the connector and complete the connection.
  </Step>
</Steps>

## Register the Private Cloud Connector in Connect AI

To register the Private Cloud Connector in Connect AI:

<Steps>
  <Step>
    Go to **Sources** and click **Add Connection** for a new connection, or edit an existing connection.
  </Step>

  <Step>
    Click the **Private Cloud Connector** tab in the **Add/Edit Connection** page.
  </Step>

  <Step>
    In **Connectors**, click **Add**. The **Add Connector** dialog appears.

    <Frame>
      <img alt="Add Connector" />
    </Frame>
  </Step>

  <Step>
    Enter a descriptive location name to identify where the connector is installed, and click **Confirm**.

    Your location appears in the **Connectors** list, along with a key and a **Pending** status. Click the eye icon to view the key.

    <Frame>
      <img alt="Connectors List" />
    </Frame>

    You must copy the following values for the connector (click the copy icons):

    * **Account Id**–this is the ACCOUNT\_ID environment variable for the connector.
    * **Location Id**–this is the GATEWAY\_LOCATION\_ID environment variable for the connector.
    * **Key**–this is the GATEWAY\_API\_KEY environment variable for the connector.
  </Step>
</Steps>

## Deploy the Private Cloud Connector with Docker

The Private Cloud Connector is a lightweight service that runs inside your network and acts as a secure reverse tunnel between Connect AI and your local data sources. The connector registers itself with Connect AI on startup. It then listens for incoming connections, via Azure Relay technology, without ever exposing them to the public internet.

The connector is protocol-agnostic: it forwards raw bytes without any knowledge of the database protocol (such as MySQL, PostgreSQL, or SQL Server), making it compatible with any TCP-based data source.

### Prerequisites

To run the Private Cloud Connector as a Docker container, you must have the following:

* Docker installed on the host machine.
* Network access to `cloud.cdata.com`.
* The connector created in Connect AI.
* Host IP forwarding (`net.ipv4.ip_forward=1`) enabled. Docker requires this for container outbound connectivity; note that OS patching and security-hardening baselines (CIS/STIG) may reset it to 0.
* Egress TLS inspection must be bypassed for `*.servicebus.windows.net`, `*.azurecr.io`, and `*.cdata.com`. SSL inspection on these endpoints will prevent the connector relay tunnel from establishing.

### Environment Variables

The following environment variables are required to run the connector:

| Variable | Description |
| :- | :- |
| GATEWAY\_LOCATION\_ID | The unique identifier for this connector instance. Copy the value under the user-defined **Location Name** in the Connectors list in Connect AI. |
| GATEWAY\_API\_KEY | The secret API key used to authenticate this connector with Connect AI. Copy the value under **Key** in the Connectors list in Connect AI. |
| ACCOUNT\_ID | Your CData Connect AI account identifier. This is specific to your organization. Copy **Account Id** in the Connectors list in Connect AI. |

### Run the Connector in Docker

Run the connector as follows:

```bash wrap theme={null}
docker run \
    --name my-onprem-gateway \
    -e GATEWAY_LOCATION_ID=<gateway_location_id> \
    -e GATEWAY_API_KEY=<gateway_api_key> \
    -e ACCOUNT_ID=<account_id> \
    connectaipublic.azurecr.io/connectgateway:latest
```

<Note>`docker run` will pull the Docker image from the registry if it is not already present on the host.</Note>

#### View Docker Logs

```bash wrap theme={null}
docker logs -f my-onprem-gateway
```

#### Stop the Connector

```bash wrap theme={null}
docker stop my-onprem-gateway
docker rm my-onprem-gateway
```

### Docker Compose

Copy the following and save as `docker-compose.yml`:

```yaml theme={null}
version: "3.8"

services:
  onprem-gateway:
    image: connectaipublic.azurecr.io/connectgateway:latest
    container_name: my-onprem-gateway
    restart: unless-stopped
    environment:
      GATEWAY_LOCATION_ID: <gateway_location_id>
      GATEWAY_API_KEY: <gateway_api_key>
      ACCOUNT_ID: <account_id>
```

#### Start the Private Cloud Connector

```bash wrap theme={null}
docker compose up
```

<Note>`docker compose up` will pull the Docker image from the registry if it is not already present on the host.</Note>

#### View Logs

```bash wrap theme={null}
docker compose logs -f
```

#### Stop the Private Cloud Connector

```bash wrap theme={null}
docker compose down
```

## Deploy the Private Cloud Connector on Kubernetes

The Private Cloud Connector Kubernetes Helm chart is available in a [GitHub repository](https://github.com/CDataSoftware/connect-gateway-helm/).

### Prerequisites

To deploy the Private Cloud Connector on Kubernetes, you must have the following:

* Kubernetes 1.25 or later
* Helm 3.10 or later
* Metrics Server installed on your cluster (required for memory-based autoscaling)
* Network egress from the cluster to `cloud.cdata.com`
* Egress TLS inspection must be bypassed for `*.servicebus.windows.net`, `*.azurecr.io`, and `*.cdata.com`. SSL inspection on these endpoints will prevent the connector relay tunnel from establishing.
* Your **Account Id**, **Location Id**, and **Key** from Connect AI. See [Register the Private Cloud Connector in Connect AI](#register-the-private-cloud-connector-in-connect-ai) for the location of these values.

### Quick Start

Add the Helm repository:

```bash wrap theme={null}
helm repo add cdata https://cdatasoftware.github.io/connect-gateway-helm
helm repo update
```

Install the chart:

```bash wrap theme={null}
helm install connect-gateway cdata/connect-gateway \
  --set gateway.locationId=<location-id> \
  --set gateway.accountId=<account-id> \
  --set gateway.apiKey=<api-key> \
  -n connect-gateway --create-namespace
```

You can also install directly from a [GitHub release](https://github.com/CDataSoftware/connect-gateway-helm/releases). This is useful for air-gapped environments or when you do not want to add a Helm repo. Replace the version in the URL below with the latest release.

```bash wrap theme={null}
helm install connect-gateway \
  https://github.com/CDataSoftware/connect-gateway-helm/releases/download/v1.0.0/connect-gateway-1.0.0.tgz \
  --set gateway.locationId=<location-id> \
  --set gateway.accountId=<account-id> \
  --set gateway.apiKey=<api-key> \
  -n connect-gateway --create-namespace
```

<Note>For production, create a Kubernetes Secret containing your gateway credentials and pass `--set existingSecret=<secret-name>` instead of `--set gateway.apiKey=…`. Passing the API key with `--set` writes it to shell history and to the Helm release's stored values. See the Helm chart [Readme file](https://github.com/CDataSoftware/connect-gateway-helm/blob/main/charts/connect-gateway/README.md) for secret-management patterns.</Note>

### Verify the Private Cloud Connector is Running

Check that the connector pods are ready and view their logs:

```bash wrap theme={null}
kubectl get pods -n connect-gateway
kubectl logs -n connect-gateway -l app.kubernetes.io/name=connect-gateway -f
```

### Upgrade the Private Cloud Connector

```bash wrap theme={null}
helm repo update
helm upgrade connect-gateway cdata/connect-gateway -n connect-gateway
```

### Uninstall the Private Cloud Connector

```bash wrap theme={null}
helm uninstall connect-gateway -n connect-gateway
```

Refer to the Helm chart [Readme file](https://github.com/CDataSoftware/connect-gateway-helm/blob/main/charts/connect-gateway/README.md) for the full list of installation options, configuration values, and secret-management patterns.

## Finish Private Cloud Connector Setup

Return to Connect AI and finish the Private Cloud Connector setup.

<Steps>
  <Step>
    After you complete the steps to [deploy the Private Cloud Connector with Docker](#deploy-the-private-cloud-connector-with-docker) or [deploy the Private Cloud Connector on Kubernetes](#deploy-the-private-cloud-connector-on-kubernetes), you can test the connectors you added to **Connectors**. Click the **Private Cloud Connector** tab of the **Add/Edit Connection** page. Click **Test Connectors**. The **Status** turns to **Success** if all connector setup is complete.
    <Note>You still must click **Save & Test** to test the entire connection.</Note>
  </Step>

  <Step>
    Return to the **Basic Settings** tab of your connection. Under **Connection Type**, select **Private Cloud Connector**.
  </Step>

  <Step>
    Select the **Private Cloud Connector** location to use from the drop-down list.

    <Frame>
      <img alt="Basic Settings" />
    </Frame>
  </Step>

  <Step>
    Enter the **Authentication** instructions for the connector according to the connector's **Documentation** pane.
  </Step>

  <Step>
    Click **Save & Test** to authenticate your connector.
  </Step>
</Steps>


# Private Cloud Connector Troubleshooting
Source: https://docs.cloud.cdata.com/en/Private-Cloud-Connector-Troubleshooting

Common issues when running the Private Cloud Connector, with step-by-step diagnostics and fixes.

## Common Issues

<AccordionGroup>
  <Accordion title="The connector shows a 'tunneling configuration' timeout or restarts repeatedly.">
    **Symptom:** The Connector container logs show `ConnectTimeoutException: connection timed out cloud.cdata.com:443` and the container restarts in a loop. The Connector never reaches **Success** status in Connect AI.

    **Step 1: Test host egress (independent of Docker)**

    Run the following on the host:

    ```bash theme={null}
    curl -v https://cloud.cdata.com/api
    ```

    If the TLS handshake completes and you receive any HTTP response (for example, a 404), host egress is healthy and the issue is container-level, not your corporate firewall.

    **Step 2: Check IP forwarding**

    If the host can reach `cloud.cdata.com` but the container cannot, verify IP forwarding on the host:

    ```bash theme={null}
    sysctl net.ipv4.ip_forward
    ```

    If this returns `0`, the host cannot route the container's outbound traffic to the internet. Docker requires IP forwarding to be enabled. Enable it:

    ```bash theme={null}
    sudo sysctl -w net.ipv4.ip_forward=1
    ```

    The Connector reconnects on its next retry. No rebuild or image re-pull is needed, and the local image and configuration are unaffected.
  </Accordion>

  <Accordion title="Issues keeping the Connector connected across reboots, patches, and hardening.">
    `net.ipv4.ip_forward` is commonly reset to `0` by OS reboots, patch cycles, and security-hardening baselines. Apply the level of persistence your environment requires.

    **Survives a reboot:** Add a persistent sysctl setting:

    ```bash wrap theme={null}
    echo 'net.ipv4.ip_forward = 1' | sudo tee /etc/sysctl.d/99-ip-forward.conf
    sudo sysctl --system
    ```

    **Survives patching and security hardening (CIS / DISA STIG environments):** Many hardened images (for example, corporate RHEL builds) disable IP forwarding as a standard security control and re-apply that control on every patch or configuration-management run. In these environments, the sysctl file above might be overridden. To prevent recurrence, the team that owns the hardening baseline must add a host-level exception:

    * Permit `net.ipv4.ip_forward=1` on hosts running the Connector, on the basis that Docker requires IP forwarding for container connectivity.
    * If forwarding must remain globally disabled, apply a scoped forward/masquerade rule allowing only the Docker bridge subnet outbound to `cloud.cdata.com` on port 443.

    Both are narrow, deliberate exceptions and do not reduce the host's overall hardening posture.

    **To identify what is resetting the value:**

    ```bash wrap theme={null}
    grep -rns 'ip_forward' /etc/sysctl.conf /etc/sysctl.d/ /usr/lib/sysctl.d/
    ```

    A hardening file setting `net.ipv4.ip_forward = 0` with a load order after `99-ip-forward.conf` is the line the exception must override.
  </Accordion>

  <Accordion title="The Connector connects then disconnects repeatedly / SSL handshake failure.">
    **Symptom:** The Connector container logs show repeated entries like:

    ```
    SSLHandshakeException: Abruptly closed by peer
    java.io.IOException: Broken pipe
    Failed to open Azure Relay listener
    Scheduling reconnect in 5 seconds...
    ```

    The Connector might show **Success** in Connect AI intermittently, but connections fail with `HTTP [40005] Invalid HTTP response ... Action impossible while not connected`.

    **Cause:** SSL/TLS inspection on your egress firewall or proxy is intercepting and terminating the Connector's outbound WebSocket connection to Azure Service Bus. The Connector expects to complete a TLS handshake directly with Microsoft's Azure infrastructure; when an inspection appliance presents its own certificate instead, the handshake fails.

    **Fix:** Request a TLS inspection bypass from your network/security team for the following hostnames:

    * `*.servicebus.windows.net`–Azure Service Bus (Connector relay tunnel)
    * `*.azurecr.io`–Azure Container Registry (Connector image pull)
    * `*.cdata.com`–CData cloud infrastructure

    These are Microsoft Azure and CData infrastructure endpoints. Bypassing TLS inspection for these hosts does not reduce overall security posture; it allows the Connector to complete its intended encrypted connection directly with the service endpoint.

    **Alternative:** If a full TLS bypass is not permitted, your network team can export the internal CA certificate used by the inspection appliance and add it to the Connector container's Java trust store. This allows the Connector to trust the intercepted certificate and complete the handshake. Contact [CData Support](https://www.cdata.com/support/submit.aspx) for guidance on this approach.
  </Accordion>
</AccordionGroup>

## Additional Help

For additional help, contact [CData Support](https://www.cdata.com/support/submit.aspx).


# Quick Start Guide
Source: https://docs.cloud.cdata.com/en/Quick-Start-Embedded

Connect AI Embed is a way for customers to integrate Connect AI live data access capabilities for their end users within their own applications.

Contact CData sales if you are interested in a Connect AI Embed account.

Connect AI Embed uses a two-level account structure:

* **Parent Account**—Created by CData for your organization. As the ISV, you use the parent account to manage your entire Connect AI Embed deployment, including creating, viewing, and monitoring sub-accounts through the Connect AI Embed interface or API.
* **Sub-Account**—One sub-account is created for each of your customers. Within a sub-account, end users can connect to data sources and query data. The access privileges you grant determine what each end user can create, edit, or delete.

The Connect AI Embed **Accounts** page contains the sub-account names, external Id, and account Ids for reference.

<Frame>
  <img alt="" />
</Frame>

Click the edit icon to change the account name or external Id.
Click the delete icon to delete the sub-account.

## Connect AI Embed Quick Start

The following is an overview of setting up Connect AI Embed. There are five main steps.

### Step 1: Create a Parent Account

<Steps>
  <Step>
    CData sets up a parent account for you and sends you the account information, including the account name and account Id.
  </Step>

  <Step>
    The administrator of the Connect AI Embed parent account [creates a JSON Web Token (JWT)](/en/API/Authentication-Embedded), which consists of a private key and a corresponding public key. The private key must be stored according to the security requirements of the product integrated with Connect AI Embed.
  </Step>

  <Step>
    The administrator provides the public key certificate in Privacy-Enhanced Mail (PEM) format to register the management account. They can register the public key by opening a support ticket with Connect AI.
  </Step>

  <Step>
    Once registered, the administrator of the parent account can sign in to the account. Please accept the terms of service.
  </Step>

  <Step>
    The parent account's administrator creates and manages the sub-accounts.
  </Step>
</Steps>

### Step 2: Create a Sub-Account

Once you have created the parent account, you can create the sub-accounts in one of two ways:

* In the **Accounts** page, click **+Add account**. Enter the **Account Name** and **External ID** of the sub-account, and click **Confirm**.

* Use [Create Account](/en/API/Account-API) in the [Connect AI Embed API](/en/API/REST-API-Embedded) to create a sub-account. You must supply the JWT that you created in [Create a Parent Account](#step-1:-create-a-parent-account), as well as the External ID of the sub-account.

### Step 3: Configure Connection Settings (Optional)

Connect AI Embed gives you two ways to configure connection settings centrally across your sub-accounts.

* Connection Overrides: Configure a connection setting once at the parent account level and push it to all sub-accounts automatically. This eliminates per-tenant maintenance as you scale. See the [Sources](/en/Settings-Embedded#sources) section in the **Settings** documentation for configuration steps.
* Branded OAuth Apps: Register your own OAuth application with data source providers so your customers authenticate under your brand rather than CData's. When a sub-account user connects Salesforce or another OAuth source, they see your application name—not CData's. See the [Sources](/en/Settings-Embedded#sources) section in the **Settings** documentation for configuration steps.

The existing Custom Overrides feature described below also remains available for other connection property overrides.

Custom overrides allow end users to log in with their own organization's OAuth credentials rather than CData credentials. To add connection overrides, follow these steps:

<Steps>
  <Step>
    In the **Sources** tab of the **Settings** page, click **+Add Override**.
  </Step>

  <Step>
    Search for the data source to override. Click **Next**.
  </Step>

  <Step>
    Select the **Setting** to override.
  </Step>

  <Step>
    Enter the **Override Value**.
  </Step>

  <Step>
    Select whether the value should apply to new connections only or to all connections (new and existing).
  </Step>

  <Step>
    Click **Confirm**.
  </Step>
</Steps>

End users can now use the custom credentials.

### Step 4: Configure a Connection

An end user of the sub-account clicks **Add Connection** on your web page. On the backend, your web site calls [Create Connection](/en/API/Connection-API), which generates a redirect URL to the Connect AI Embed web page. The end user can then configure a connection of a certain type, such as a Salesforce connection, and save and test the connection. When the end user is finished, Connect AI Embed redirects them back to your web page, which contains a list of connections. See [Connection Flow](/en/Connection-Flow) for more details.

### Step 5: Query the Data Using AI

Once your data source is connected, your application can use AI to interact with end-user data in natural language. Connect AI Embed's MCP server bridges your AI agent and your customers' connected accounts (such as Jira or Salesforce). Each sub-account's connections are isolated—AI workflows for one sub-account cannot access another's data. A JWT containing a `connection_ids` claim, generated by your server, scopes each request to the correct end user. See [MCP](/en/API/MCP-Embedded) for more information.

You can also use one of the following Connect AI drivers to query the data:

* [ADO.NET](/en/Clients/ADO.NET-Client-Embedded)
* [ODBC](/en/Clients/ODBC-Client-Embedded)
* [JDBC](/en/Clients/JDBC-Client-Embedded)
* [Python](/en/Clients/Python-Client-Embedded)

In addition, Connect AI Embed provides a full-featured [REST API](/en/API/REST-API-Embedded). You can query data directly with any REST-compatible application or integration tool capable of creating HTTP requests.

### View Logs

Use the [**Logs**](/en/Logs-Embedded) page or the [Log API](/en/API/Log-API-Embedded) to view and download a list of logs for a Connect AI Embed account.


# Release Notes
Source: https://docs.cloud.cdata.com/en/ReleaseNotes



<Update label="September 18, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Playground now maintains its topic guardrails throughout a conversation and no longer answers unrelated general questions.
  * Microsoft connectors now expose the **Client Id** and **Client Secret** properties in the connection's **Advanced** tab for all Azure AD-based authentication schemes.
  * Fixed an issue where the Time Check Column list was empty when creating a cache job for connections with dynamic schemas, preventing incremental updates from being configured.
  * Fixed two issues with scheduled query destinations: destination table creation failed when the source included column types not supported by those names on the destination (such as floating-point columns writing to PostgreSQL), and currency and decimal columns from some sources were created without decimal precision on the destination, causing values to be rounded.
  * Fixed an issue where service accounts appeared to have no connections when listing catalogs or using the `search_context` MCP tool, even when connection permissions had been explicitly granted to the service account.

  #### Connectors

  * Apache Impala (Update): Connector updated to support Connect Gateway.
  * API Connector (Update): Connector now sends the authorization header correctly for bearer token and API key authentication schemes, fixing authorization errors when previewing or querying a request.
  * Gong (Update): Connector updated to fix datetime filters not being applied correctly.
  * Google Forms (Update): Connector updated to fix connections failing with an authorization error about an hour after being saved.
  * Greenplum (Update): Connector updated to support Connect Gateway.
  * HCL Domino (Update): Connector updated to fix column metadata not loading for tables.
  * Informix (Update): Connector updated to support Connect Gateway.
  * NetSuite (Update): Connector updated to fix JOIN queries failing when a CAST was applied to the join key.
  * Power BI XMLA (Update): Connector updated to fix JOIN and CASE expression queries failing in DAX query mode.
  * REST (Update): Connector updated to fix bearer token and API key authentication headers not being sent for requests against tables, causing authorization errors.
  * Sage Intacct (Update): Connector updated to fix pseudocolumn values missing from custom report results.
  * SendPulse (New): New connector added to Connect AI.
  * ServiceDesk Plus (Update): Connector updated to fix queries returning no rows.
  * SingleStore (Update): Connector updated to support Connect Gateway.
  * Yelp (New): New connector added to Connect AI.
  * Zendesk (Update): Connector updated to fix an issue where comment attachment downloads failed.
  * Zoho CRM (Update): Connector updated to fix array fields, such as Tag, that were returning null when using the COQL API.
</Update>

<Update label="September 11, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * When creating a job, you can now search for a connection in a search bar instead of scrolling through the full list.
  * On the **Integrations** page, you can now search for integrations across all categories instead of searching by category.
  * Playground now displays a card highlighting additional business sources available in Connect AI.
  * Toolkit MCP tools now always include the `getInstructions` tool and prompt the AI to call it before querying data, reducing errors and unnecessary tool calls that occurred when the instructions step was skipped.
  * Fixed an issue where toolkit queries returned incorrect catalog, schema, or table names on accounts using the DV engine.
  * Fixed an issue where stored procedures returned no results or ignored date and time parameters on accounts using the DV engine.
  * Fixed an issue where metadata lookups failed for table or column names containing an underscore or backslash.
  * The API Connector setup now warns when the OAuth Authorization URL is not reachable from the browser.

  #### Connectors

  * Agile CRM (New): New connector added to Connect AI.
  * Amazon Redshift (Update): Connector updated to support Connect Gateway.
  * Facebook Ads (Update): Connector updated to enable per-user authentication in Connect AI.
  * Gong (Update): Connector updated to fix `CallsExtensive` queries returning only call metadata, omitting fields such as Parties, Content, and Interaction.
  * Google Calendar (Update): Connector updated to fix calendar event queries that could return fewer rows than expected, and to fix event attachment queries that stopped before returning all results.
  * Procore (Update): Connector updated to fix invoice number formatting and queries that returned no data when filtered by company.
  * Samanage (New): New connector added to Connect AI.
  * SAP Business ByDesign (Update): Connector updated to fix missing table names when using OData data sources.
</Update>

<Update label="September 4, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Users managed by SCIM can no longer be deleted directly in Connect AI.
  * A new `getStarted` tool is now available on the Connect AI MCP server to guide new users through setup and their first data query.
  * Fixed an issue where filtering on pseudocolumns in Connect AI returned an error.
  * Fixed an issue where MCP queries timed out on large derived views.
  * Fixed an issue where API queries with 10 or more positional parameters lost their values.
  * Fixed an issue where scheduled queries from Oracle sources produced invalid decimal columns on the destination.

  #### Connectors

  * Acumatica (Update): Connector updated to fix API sessions not being released when fetching pages in parallel.
  * Backlog (Update): Connector updated to enable per-user authentication in Connect AI.
  * Couchbase (Update): Connector updated to enable per-user authentication in Connect AI.
  * Databricks Lakebase (Update): Connector updated to enable per-user authentication in Connect AI.
  * Garoon (Update): Connector updated to enable per-user authentication in Connect AI.
  * Gmail (Update): Connector updated to support sending HTML email and to reject unrecognized parameters when sending messages.
  * iContact (New): New connector added to Connect AI.
  * Mailjet (New): New connector added to Connect AI.
  * Oracle ERP and Oracle SCM (Update): Connector updated with new metadata and view-visibility connection options.
  * QuickBooks (Update): Connector updated to fix an issue where Connect Gateway connections failed with a firewall host error.
  * QuickBooks Online (Update): Connector updated to fix an issue where billable status updates failed for time activity records.
  * QuickBooks Time (Renamed): The TSheets connector has been renamed to QuickBooks Time.
  * Sage Intacct (Update): Connector updated to fix general ledger account balance returning only the first page of results.
  * Salesforce Data 360 (New): New connector added to Connect AI.
</Update>

<Update label="August 28, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Query logs now show the correct connection name instead of "Undefined" for more query types.
  * Long-running queries through the Connect AI toolkit no longer time out after 30 seconds.
  * Personal access tokens can now be used to authenticate Management API calls.
  * The SQL **Preview** tab for assets in the Query Builder no longer allows edits.
  * Per-user authentication connections can no longer be selected as a scheduled query destination.

  #### Connectors

  * Adobe Experience Manager (New): New connector added to Connect AI.
  * Azure Analysis Services (Update): Connector updated to enable per-user authentication in Connect AI.
  * Azure Table Storage (Update): Connector updated to enable per-user authentication in Connect AI.
  * Bing Ads (Update): Connector updated to enable per-user authentication in Connect AI.
  * Constant Contact (New): New connector added to Connect AI.
  * CSV (Update): Connector updated to enable per-user authentication in Connect AI.
  * GetResponse (New): New connector added to Connect AI.
  * Google Ads (Update): Connector updated to fix reporting column metadata errors after a Google Ads API version change.
  * PCAAccounting (Update): Connector updated to fix a failure when filtering on certain attribute fields.
  * PostgreSQL (Update): Connector updated to fix connection properties being ignored on SSH-tunneled connections.
  * QuickBooks (New): New connector added to Connect AI.
  * QuickBooks Online (Update): Connector updated to fix custom balance sheet reports returning unfiltered results.
  * TaxJar (New): New connector added to Connect AI.
</Update>

<Update label="August 21, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * On-premises OAuth for API connections now works through Private Cloud Connector. The authorization URL must remain publicly reachable.
  * The API Connector now supports a configurable **Scope** advanced setting for OAuth connections, resolving authentication failures that occurred with APIs that do not accept the default scope.
  * MCP source tools now correctly expose object-typed parameters as JSON objects in the tool schema. Previously, these parameters were exposed as strings, causing MCP clients to pass values as JSON-encoded text instead of structured objects.
  * Fixed an issue where tools in an MCP Toolkit failed to resolve the underlying data source connection when the session was authenticated with a service account.
  * The Data Explorer search bar now filters assets instead of toggling the workspace dropdown.
  * Fixed an issue where custom reports could not be created for connections configured with per-user authentication.
  * The audit log now records the correct entry when a user's access role changes.

  #### Connectors

  * Amazon Athena (Update): Connector updated to enable per-user authentication in Connect AI.
  * Facebook (Update): Connector updated to enable per-user authentication in Connect AI.
  * Microsoft Access (Removed): Connector no longer available as a data source in Connect AI.
</Update>

<Update label="August 14, 2026">
  ### What's New

  Data Copilot is now called Playground. Playground includes a new guided onboarding experience for many common data sources, such as Jira, GitHub, and Slack. Once you are connected to your data source, you can use AI to get answers from your connected data.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Connection validation now runs only on **Test Connection** and is no longer triggered before every query.
  * Long-running cache jobs no longer fail with a connection-closed error when writing sync status.
  * The Query Execution Engine has been updated with several bug fixes: table browsing no longer fails when tools use a `%` wildcard for catalog names, and `INSERT INTO SELECT` queries now work correctly when the source table uses an alias or a multi-connection `JOIN`.

  #### Connectors

  * Anaplan (New): New connector added to Connect AI.
  * Coda (New): New connector added to Connect AI.
  * Dynamics 365 Business Central (Update): Connector updated to fix an issue where `INSERT` statements silently ignored unknown column names instead of returning an error, causing data to be dropped without warning.
  * SAP Business Warehouse (New): New connector added to Connect AI.
  * Sage Intacct (Update): Connector updated to fix per-user authentication with the Azure AD authentication scheme.
  * ServiceDesk Plus (New): New connector added to Connect AI.
  * Suadeo (New): New connector added to Connect AI.
  * Twilio (Update): Connector updated to add template support to the `SendMessage` stored procedure, enabling WhatsApp messages to be sent using Twilio Content Templates.
  * Zoho People (Update): Connector updated with additional tables, along with `INSERT` support via the Forms API.
</Update>

<Update label="August 7, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The machine-to-machine (M2M) application type has been removed from OAuth Apps. Use service accounts for automated authentication.
  * AI responses in Data Copilot and AI Assistant now stream incrementally for faster responses while maintaining quality.
  * Data Copilot now collapses AI action steps (such as `getCatalogs`, `getSchemas`, and `getTables`) into a single expandable summary row.
  * Copied toolkits are now active immediately upon creation instead of requiring manual activation.

  #### Connectors

  * Acumatica (Update): Connector updated to fix slow queries where row limits were ignored during server-side filtering.
  * BenchmarkEmail (New): New connector added to Connect AI.
  * Gong (Update): Connector updated to fix an issue where Gong was not showing as available in Connect AI.
  * MailerLite (New): New connector added to Connect AI.
  * Moosend (New): New connector added to Connect AI.
  * SAP Business ByDesign (Update): Connector updated to add missing fields for the SAPIAS and SAPIASPassword authentication schemes.
  * SharePoint (Update): Connector updated to fix a core metadata cache issue that caused a DELETE/INSERT key mismatch on procedure calls.
</Update>

<Update label="July 31, 2026">
  ### What's New

  Data Security is now available for Business tier customers and above. Administrators can configure rules to automatically detect and mask personally identifiable information (PII) in queries flowing through Connect AI. Each rule targets a specific data type and can be set to warn, redact, or block data independently for inbound queries and outbound results. Connect AI includes built-in rules based on common regulation types. Administrators can also define custom rules using regular expressions. Masking is enforced across all query surfaces, including Data Explorer and MCP.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * An issue was fixed where JIT-provisioned users were assigned incorrect user IDs.
  * Private Cloud Connector now supports Tally.
  * The Virtual SQL Server instance has been updated to fix an issue where Databricks Unity Catalog Lakehouse Federation connections failed.

  #### Connectors

  * Adobe Commerce (Update): Connector updated to enable per-user authentication in Connect AI.
  * BullhornCRM (Update): Connector updated to fix a null pointer exception on metadata calls and to enable per-user authentication in Connect AI.
  * Elasticsearch (Update): Connector updated to enable per-user authentication in Connect AI.
  * Odoo (Update): Connector updated to fix a cast error that occurred when querying the `customer_rank` column with null values.
  * OneNote (Update): Connector updated to enable create, update, and delete operations through MCP in Connect AI.
  * Power BI XMLA (Update): Connections now correctly retrieve column metadata for tables, fixing an issue that prevented table columns from loading.
  * Reckon Accounts Hosted (Update): Connector updated to enable per-user authentication in Connect AI.
  * SAP Ariba Procurement (Update): Connector updated to enable per-user authentication in Connect AI.
  * SAP HANA (Update): Connector updated to enable per-user authentication in Connect AI.
  * Sage Intacct (Update): Connector updated to fix a null pointer exception on `COUNT` queries against the `Location` object.
  * SharePoint (Update): Connector updated to fix `ORDER BY` queries failing on unindexed fields.
  * Shopify (Update): Connector updated to support Shopify API version 2025-7. The default API schema has been updated from 2024-07 to 2025-07. API schemas prior to 2025-01 are no longer supported.
  * Teradata (Update): Connector updated to fix an issue where queries using `DISTINCT` and `LIMIT` together failed when QueryPassthrough was disabled.
  * Typeform (New): New connector added to Connect AI.
</Update>

<Update label="July 24, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The Virtual SQL Server instance has been updated to fix an issue where bad credentials caused spam login attempts.

  #### Connectors

  * Azure Data Catalog (New): New connector added to Connect AI.
  * Azure Data Lake Storage (New): New connector added to Connect AI. The previous Azure Data Lake connector is now considered legacy. Legacy users can migrate to other connectors, such as CSV or JSON.
  * Bitly (New): New connector added to Connect AI.
  * Cloudflare (New): New connector added to Connect AI.
  * Exa (New): New connector added to Connect AI.
  * Figshare (New): New connector added to Connect AI.
  * Grafana (New): New connector added to Connect AI.
  * Jumpseller (New): New connector added to Connect AI.
  * Mode (New): New connector added to Connect AI.
  * MYOB (Update): Connector updated to the latest version. This update incorporates new OAuth scope changes announced by MYOB as part of an upcoming API update, ensuring Connect AI remains compatible with their revised authentication requirements.
  * OneNote (Update): Connector updated to the latest version. This update fixed an issue where the `UserId` was not being sent to the server when inserting a section with `DefaultUser=AllUsers`, causing an incorrectly formed URL in the Microsoft Graph API request.
  * Oracle Service Cloud (Update): Connector updated to enable per-user authentication in Connect AI.
  * PolarTeamPro (New): New connector added to Connect AI.
  * Printify (New): New connector added to Connect AI.
  * Query Federation (Update): Connector updated to version 25.0.9669.0. This update fixed an issue where the combined `name` and `_customerid_value` filters on the `search_opportunities` entity were not working correctly.
  * QuickBooks Online (Update): Connector updated to the latest version. The connector now correctly maps `APAgingSummary` to Intuit's `AgedPayables` endpoint, mirroring how `ARAgingSummary` already mapped to `AgedReceivables`.
  * Sage Intacct (Update): Connector updated to fix an `OutOfMemoryError` caused by a missing `SupDocId` filter pushdown, which forced a large attachments table to be downloaded, buffered into memory, and silently retried multiple times after failure.
  * Shippo (New): New connector added to Connect AI.
  * Wave Financial (New): New connector added to Connect AI.
  * Wistia (New): New connector added to Connect AI.
  * Zendesk (Update): Connector updated to fix the `Tickets.Solved_At` field incorrectly included in the data model. The solved timestamp is now available via the `TicketMetrics` table.
</Update>

<Update label="July 17, 2026">
  ### What's New

  * Just-in-time (JIT) user provisioning is now available for Enterprise accounts with SSO configured. When enabled, users are automatically provisioned to your Connect AI account on first login without requiring an invitation. Administrators can enable JIT per SSO email domain and assign a default access role to JIT-provisioned users. JIT provisioning is not available for accounts using SCIM.
  * Service Accounts are now available in Connect AI. A service account is a non-human identity, such as an agent, script, or automated job, that authenticates via OAuth 2.0 Client Credentials. Service accounts can be assigned access roles and connection permissions, and are managed from the **Users** page under the **Service Accounts** tab.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Private Cloud Connector now supports Microsoft Exchange.

  #### Connectors

  * Acumatica (Update): Connector updated to enable per-user authentication in Connect AI.
  * Adobe Target (New): New connector added to Connect AI.
  * Apify (New): New connector added to Connect AI.
  * AWeber (New): New connector added to Connect AI.
  * Bannerbear (New): New connector added to Connect AI.
  * CollaboFlow (New): New connector added to Connect AI.
  * Discord (New): New connector added to Connect AI.
  * Freshteam (New): New connector added to Connect AI.
  * Google Analytics (Update): Connector updated to expose `UseDefaultDimensions` and `UseDefaultMetrics` configuration properties.
  * Google Forms (New): New connector added to Connect AI.
  * Guru (New): New connector added to Connect AI.
  * HDFS (New): New connector added to Connect AI.
  * Hive (New): New connector added to Connect AI.
  * Klipfolio (New): New connector added to Connect AI.
  * LDAP (New): New connector added to Connect AI.
  * Microsoft Access (New): New connector added to Connect AI.
  * MySQL (Update): Connector updated to the latest version.
  * Oracle Eloqua (Update): Connector updated to enable per-user authentication in Connect AI.
  * Oracle Sales (Update): Connector updated to enable per-user authentication in Connect AI.
  * Paymo (New): New connector added to Connect AI.
  * PCA Accounting (New): New connector added to Connect AI.
  * PingOne (New): New connector added to Connect AI.
  * Reckon (New): New connector added to Connect AI.
  * Sage HR (New): New connector added to Connect AI.
  * Sage Intacct (Update): Connector updated to fix queries that failed with "object definition not found" errors.
  * SAP HANA XSA (New): New connector added to Connect AI.
  * Salesloft (New): New connector added to Connect AI.
  * SharePoint (Update): Connector updated to fix `PageSize` issues where SharePoint always used 100-row pagination.
  * ShipEngine (New): New connector added to Connect AI.
  * Shortcut (New): New connector added to Connect AI.
  * SQL Server (Update): Connector updated to the latest version.
  * Tavily (New): New connector added to Connect AI.
  * Teradata (New): New connector added to Connect AI.
  * Toggl (New): New connector added to Connect AI.
  * UMSaaSCloud (New): New connector added to Connect AI.
  * Yahoo Shopping (New): New connector added to Connect AI.
  * Zendesk (Update): Connector updated to fix an issue where connections using `PreferPersistedTokens=true` would fail to refresh an expired access token.
  * Zoho Expense (New): New connector added to Connect AI.
  * Zoho Invoice (New): New connector added to Connect AI.
  * Zoho Marketing Hub (New): New connector added to Connect AI.
  * Zoho Subscriptions (New): New connector added to Connect AI.
</Update>

<Update label="July 10, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * Bitbucket (New): New connector added to Connect AI.
  * Campaigner (New): New connector added to Connect AI.
  * LinkedIn (Update): Connector updated to enable per-user authentication in Connect AI.
  * MailChimp (Update): Connector updated to fix an issue with SurveyResponses not returning all the results.
  * Notion (New): New connector added to Connect AI.
  * Omnisend (New): New connector added to Connect AI.
  * Parquet (Removed): Connector removed from Connect AI.
  * Perplexity (New): New connector added to Connect AI.
  * Power BI XMLA (Update): Connector updated to enable per-user authentication in Connect AI.
  * RSS (New): New connector added to Connect AI.
  * Salesforce (Update): Source tools are now available for Salesforce in Connect AI, enabling CREATE, UPDATE, and DELETE operations via MCP.
  * Slack (Update): Source tools are now available for Slack in Connect AI, enabling CREATE, UPDATE, and DELETE operations via MCP. The connector was also updated to fix source tool issues, including incorrect mandatory parameter requirements.
  * SparkPost (New): New connector added to Connect AI.
  * Stripe (Update): Connector updated to enable per-user authentication in Connect AI.
  * Supabase (New): New connector added to Connect AI.
  * XML (New): New connector added to Connect AI.
  * Zoho Desk (New): New connector added to Connect AI.
  * Zoho People (New): New connector added to Connect AI.
</Update>

<Update label="July 3, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The `queryData` MCP tool now returns results in CSV format instead of JSON format. CSV uses fewer tokens than JSON, resulting in smaller payloads for AI models. CSV is also faster to parse and maps naturally to tabular query results.

  #### Connectors

  * Apache Kafka (New): New connector added to Connect AI.
  * auPAYMarket (Wowma) (New): New connector added to Connect AI.
  * eBay Analytics (New): New connector added to Connect AI.
  * GitHub (Update): Connector updated to fix multiple tool issues, including empty string schema validation, false success on already-closed PRs, incorrect PR review event handling, and misaligned workflow run status filters.
  * Google Cloud Storage (New): New connector added to Connect AI.
  * HCL Domino (Update): Connector updated to fix OAuth access token refresh failures after token expiration.
  * HubDB (New): New connector added to Connect AI.
  * Oracle Fusion (Update): Oracle ERP, Oracle HCM, and Oracle SCM updated to latest version to add OAuth authentication support. This update fixes an OAuth issue in Web mode by removing unnecessary parameters.
  * Sage 300 (New): New connector added to Connect AI.
  * Sage Intacct (Update): Connector updated to fix `RecordNo` column filters and sorting not being pushed server-side, and ampersand characters not properly encoded in `IN` clauses.
  * Salesforce (Update): Connector updated to fix an issue with duplicate metadata caused by FQNs (fully qualified names) in projection subqueries.
  * SuiteCRM (New): New connector added to Connect AI.
  * Timely (New): New connector added to Connect AI.
  * xBase (New): New connector added to Connect AI.
  * Xero (Update): Connector updated to the latest version. This fixes an issue where `IN` clause queries on non-server-side columns sent duplicate API requests instead of fetching once and filtering client-side.
</Update>

<Update label="June 26, 2026">
  ### What's New

  * The AI Assistant is now available on **Add Connection** pages. Ask the AI Assistant for help with authenticating your connections.
  * For dual-architecture connectors such as Confluence and Jira, MCP Source Tools are now generated based on the connected instance type. This resolves errors that occurred when connecting to Server or Data Center environments.

  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * Authorize.net (New): New connector added to Connect AI.
  * Dynamics NAV (New): New connector added to Connect AI.
  * Epicor Kinetic (Update): Connector updated to the latest version. The update fixes an issue with OAuth scope handling that was causing authentication failures.
  * Gong (New): New connector added to Connect AI.
  * Jira (Update): Connector updated to the latest version. The connector update added a new `GetCurrentUser` stored procedure that returns the currently authenticated user's identity. This was needed so that AI agents in Connect AI's MCP toolkit can resolve "who am I" for prompts like "list issues assigned to me."
  * MySQL (Update): Connector updated to fix an issue where tables with a column named `char` could not be queried through a linked server.
  * Pinterest (New): New connector added to Connect AI.
  * Procore (New): New connector added to Connect AI.
  * QuickBooks Online (Update): Connector updated to version 26 to comply with Intuit's API changes. The new API changes null values, row ordering, column titles, and empty sections, and deprecates the `GroupBy` parameter.
  * Redis (Update): Connector updated to fix TLS connection failures caused by incorrect SSL property parsing.
  * SFTP (New): New connector added to Connect AI.
  * Splunk (Update): Connector updated to the latest version. This update added seven new queryable views and four new stored procedures, exposing MCP Source Tools for agentic AI workflows.
  * Sybase (New): New connector added to Connect AI.
</Update>

<Update label="June 19, 2026">
  ### What's New

  * Amazon Quick is now available as a supported AI integration.
  * Private Cloud Connector now supports Redis.
  * The following sources now support per-user authentication in Connect AI: Kintone and SAP Concur.

  #### Connectors

  * Dynamics 365 (Update): Connector updated to the latest version to expose hidden connection properties and to return system attributes of `statecode` and `statuscode`.
  * Email (New): New connector added to Connect AI.
  * Epicor (Update): Connector updated to fix duplicate results when paging without ORDER BY.
  * FinancialForce (New): New connector added to Connect AI.
  * FreshBooks (New): New connector added to Connect AI.
  * Freshservice (New): New connector added to Connect AI.
  * GitHub (Update): Connector updated to add support for issue assignment, label management, and workflow actions.
  * IBM Cloud Object Storage (New): New connector added to Connect AI.
  * Kintone (Update): Connector updated to enable per-user authentication in Connect AI.
  * MarkLogic (New): New connector added to Connect AI.
  * Microsoft Analysis Services (SSAS) (New): New connector added to Connect AI.
  * NetSuite (Update): Connector updated to expose the Role ID as an editable connection property.
  * OneDrive (New): New connector added to Connect AI.
  * Salesforce (Update): Connector updated to fix a null pointer exception on complex queries and duplicated rows in results.
  * SAP Business One (Update): Connector updated to fix date filter errors when using the Service Layer.
  * SAP Concur (Update): Connector updated to enable per-user authentication in Connect AI.
  * SAS Xpt (New): New connector added to Connect AI.
  * SharePoint (Update): Connector updated to fix stored procedure execution failures.
</Update>

<Update label="June 12, 2026">
  ### What's New

  * Enterprise Key Vault is now available for Business tier Connect AI customers. You can register your own Azure Key Vault under **Settings > Security** and reference its stored secrets when authenticating data source connections, instead of entering credentials directly into Connect AI. Because the credentials stay in your vault and are resolved only at query time, sensitive values such as passwords and tokens are never stored in the Connect AI database. This gives you centralized control of your credentials, an audit trail in your vault logs each time Connect AI reads a secret, and the ability to rotate credentials in your vault without updating each connection in Connect AI.
  * Private Cloud Connector now supports Epicor and SAP BusinessObjects BI as sources.
  * The following sources now support per-user authentication in Connect AI: Dynamics 365, Quickbase, and SAP SuccessFactors.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue that caused decimal columns in Google Data Studio to not parse correctly.
  * Fixed an issue in the Google Sheets add-on where parametrized queries threw a malformed SQL error on refresh.

  #### Connectors

  * Apache Cassandra (New): New connector added to Connect AI.
  * Apollo (New): New connector added to Connect AI.
  * Avro (New): New connector added to Connect AI.
  * Confluence (Update): Connector updated to add embedded OAuth support.
  * SAP ByDesign (Update): Connector updated to fix AzureAD OAuth failures caused by a missing Basic auth header on SAML2-bearer token requests.
  * Zendesk (Update): Connector updated to fix an issue where ORDER BY caused WHERE filters to be dropped and LIKE clauses not to be applied server-side.
</Update>

<Update label="June 5, 2026">
  ### What's New

  * You can now manage permissions in bulk by using Role-Based Access Control (RBAC). In addition to the four predefined platform roles (Administrator, Connection Administrator, User Administrator, and Query), account administrators can now define custom roles that bundle entity permissions for data connections and workspaces, then assign them to many users at once. Custom roles let you grant each user only the access they need across your account. Permissions are additive, so when a user is assigned multiple roles, they receive the combined permissions of all those roles. Because permissions are managed through reusable roles instead of user by user, you can onboard new team members and keep permissions consistent across teams with far less manual effort.
  * Connect AI connector skills are now published in a public GitHub repository, [connect-ai-skills](https://github.com/CDataSoftware/connect-ai-skills). These downloadable skills guide LLMs and AI agents through correct source discovery and query construction for each data source.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Embedded users can now override the OAuth Client Id and Client Secret for Xero connections.
  * Fixed the Looker Studio integration and renamed it back to Google Data Studio.

  #### Connectors

  * Apache CouchDB (New): New connector added to Connect AI.
  * Apache HBase (New): New connector added to Connect AI.
  * BambooHR (New): New connector added to Connect AI.
  * Confluence (Update): Connector updated to add the StorageBody field to Pages tables for on-premises compatibility.
  * Dynamics 365 (Update): Connector updated to the latest version.
  * Dynamics 365 Business Central (Update): Connector updated to fix on-premises connection configuration options.
  * EnterpriseDB (New): New connector added to Connect AI.
  * FTP (New): New connector added to Connect AI.
  * JSON (New): New connector added to Connect AI.
  * QuickBase (Update): Connector updated to enable user-defined credentials.
  * Salesforce (Update): Connector updated to fix an issue affecting count queries on reports and validation rules.
  * SAP SuccessFactors (Update): Connector updated to enable user-defined credentials.
  * ServiceNow (Update): Connector updated to add support for AzureAD as an authentication scheme.
  * Smartsheet (Update): Connector updated so the `useLegacyAPI` property now defaults to false ahead of the legacy API sunset.
  * Splunk (Update): Connector updated to add support for accessing indexes.
  * SugarCRM (Update): Connector updated to fix server-side filtering on related columns and LIKE queries.
  * Workday (Update): Connector updated to add prompt column metadata showing which table to query for corresponding Workday ID lookups.
  * Zoom (New): New connector added to Connect AI.
</Update>

<Update label="May 29, 2026">
  ### What's New

  The following sources are now available in Private Cloud Connector: Active Directory, AlloyDB, Amazon Athena, Amazon DynamoDB, CSV, HCL Domino, Spark SQL, and Sybase IQ.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an intermittent issue in Private Cloud Connector where the agent key was not available.

  #### Connectors

  * GitLab (New): New connector added to Connect AI.
</Update>

<Update label="May 22, 2026">
  ### What's New

  API Connector is now available as a supported source in Private Cloud Connector.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue in Connect Spreadsheets where update operations failed with data type mismatch errors when using custom SQL with a non-alphabetical column order.
  * Fixed an issue where API connections created and edited from Google Sheets or Excel loaded the wrong driver.

  #### Connectors

  * Apache Phoenix (Update): Connector updated to the latest version to fix an issue with an invalid ProjectId.
  * Jira (Update): Connector now exposes the Client Id and Secret properties in the Advanced tab, allowing customers to provide their own OAuth credentials. The driver was also updated to the latest version.
  * SAP SuccessFactors LMS (New): New connector added to Connect AI.
  * Workday (Update): Connector updated to fix issues with incorrect values in WQL prompt columns.
  * Zoho Projects (Update): Connector updated to the latest version to fix an issue with an invalid ProjectId.
</Update>

<Update label="May 15, 2026">
  ### What's New

  * Private Cloud Connector now supports SAP HANA and Apache Phoenix as sources.
  * The following sources now support per-user authentication in Connect AI: Azure Synapse, Epicor, GitHub, Office365, and SQL Server.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue in workspaces where the MCP endpoint shown after a toolkit migration was misleading.
  * Fixed a regression where the Connect AI Embed connection **Name** field was unconditionally locked, breaking existing integrations.

  #### Connectors

  * Adobe Analytics (Update): Connector updated to expose the `maxthreads` property.
  * ADP (Update): Connector updated to fix array fields returning NULL in the jobRequisitions view.
  * Apache Phoenix (New): New connector added to Connect AI.
  * Apollo (New): New connector added to Connect AI.
  * BambooHR (New): New connector added to Connect AI.
  * FreshBooks (New): New connector added to Connect AI.
  * Sage Intacct (Update): Connector updated to fix an issue passing required fields to custom reports.
  * Salesforce (Update): Connector updated to fix an incorrect redirect URI on sign-in.
  * SAP ByDesign (Update): Connector updated in Connect AI.
  * Workday (Update): AI instructions updated to include details on lookup prompt fields.
  * Zoom (New): New connector added to Connect AI.
</Update>

<Update label="May 8, 2026">
  ### What's New

  * Gemini Enterprise is now available as a supported AI integration.
  * The following sources now support per-user authentication in Connect AI: EpicorERP, Microsoft Teams, and Zendesk.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue where the per-connection MCP endpoint in Connect AI Embed was returning 403 for correctly formed JWTs.
  * The getColumns MCP tool now supports customization of the **Description** field behavior.

  #### Connectors

  * Basecamp (New): New connector added to Connect AI.
  * BullhornCRM (Update): Connector updated to fix filtering and pagination issues.
  * Garoon (Update): Fixed an issue where ORDER BY clauses caused query failures.
  * QuickBooks Online (Update): Fixed an issue where custom report creation failed when a dropdown-list parameter was used.
  * Sage Intacct (Update): Connector updated to fix incorrect values returned by MIN/MAX functions.
  * Salesforce (Update): OAuth authentication migrated to the OAuthPKCE scheme.
</Update>

<Update label="May 1, 2026">
  ### What's New

  MCP Server universal tools exposed via the generic MCP server ([https://mcp.cloud.cdata.com/mcp](https://mcp.cloud.cdata.com/mcp)) and via the Toolkits MCP Server ([https://mcp.cloud.cdata.com/mcp/toolkits/\{toolkit\_id}](https://mcp.cloud.cdata.com/mcp/toolkits/\{toolkit_id})) now behave consistently.

  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * Databricks (Update): Connector updated to fix an incorrect callback URL for the Azure AD authentication method.
  * GitHub (Update): The OAuth access token is now exposed for PAT authentication in Connect AI. The connector was also updated to the latest version.
  * Microsoft Teams (Update): Connector updated in order to enable user-defined credentials.
  * SAP Ariba Procurement (Update): Connector updated to fix an issue with dynamic tables not displaying for OperationalReportingAPIForProcurement-V2.
</Update>

<Update label="April 24, 2026">
  ### What's New

  Personal Access Tokens (PATs) now support configurable expiration dates, rotation, revocation, and audit logging for improved security.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue where the Excel add-in was retaining deleted worksheet names in the refresh list.

  #### Connectors

  * Azure DevOps (Update): Connector now supports AzureAD and Basic authentication credentials.
  * Box (New): New connector added to Connect AI.
  * Raiser's Edge NXT (Update): Connector updated to fix an issue with queries failing with internal server errors.
  * REST (Update): Connector now supports bearer key and API token as authentication credentials.
  * SAS Datasets (New): New connector added to Connect AI.
  * Zoho Projects (Update): Connector updated to fix an issue with incomplete data retrieval.
</Update>

<Update label="April 17, 2026">
  ### What's New

  * The following sources are now available in Private Cloud Connector: GitHub, Jira, and Splunk.

  * Personal Access Tokens (PATs) can now be assigned global expiration lifetimes in the **Account** tab of the **Settings** page.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * The MCP server query tool now explicitly denies DELETE queries.

  #### Connectors

  * API Connector (Fix): Fixed an issue related to validation errors in the pagination section.
  * Azure DevOps (Update): Connector updated in order to support per-user authentication.
  * Power BI XMLA (Update): Connector updated to fix an issue causing connections to fail.
  * Sage Intacct (Update): Connector updated to provide support for aggregate functions.
  * Tally (New): New connector added to Connect AI.
</Update>

<Update label="April 10, 2026">
  ### What's New

  Confluence is now a supported source in Private Cloud Connector.

  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * Bullhorn CRM (Update): Connector updated to fix an issue with malformed URLs.
  * CSV (New): New connector added to Connect AI.
  * Garoon (Update): Connector updated to add support for Messages endpoints.
  * PostgreSQL (Update): Connector updated to fix an issue related to Certificate Authority (CA) certificates.
  * REST (Update): Connector updated to fix a pagination issue.
</Update>

<Update label="April 3, 2026">
  ### What's New

  * SAP Business One is now a supported source in Private Cloud Connector.
  * Oracle Fusion (Financials Cloud, HCM Cloud, and SCM) connectors now support per-user authentication.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * The **Jobs** page now has filtering to find specific jobs.
  * **User-Defined Credentials** is now called **Per-User Authentication** in the Connect AI user interface.

  #### Connectors

  * Confluence (Update): Connector updated in order to support per-user authentication.
  * HubSpot (Update): Connector updated in order to support per-user authentication.
  * Jira Service Management (Update): Connector updated in order to support per-user authentication.
  * Sage Intacct (Update): New connection overrides added for Connect AI Embed customers.
  * Xero (Update): Connector updated to fix an issue with the BankTransactions table.
  * Zoho Creator (Update): Connector updated to fix an issue with Date columns.
</Update>

<Update label="March 27, 2026">
  ### What's New

  In Connect AI Embed, administrators can now view the sources set up by their sub-accounts.

  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * API Connector (Fix): Fixed an issue with query not recognizing added scopes.
  * Asana (Update): Connector updated to add support for per-user authentication credentials.
  * Bing Search (Deprecated): Connector deprecated from Connect AI.
  * MailChimp (Update): Connector updated to fix a customer issue.
</Update>

<Update label="March 20, 2026">
  ### What's New

  Custom MCP Tools is now available. Connect AI allows Admin users to define custom MCP tools for repeatable operations in your AI-driven workflows. These tools are available via your Connect AI workspaces.

  Connect AI, through the Private Cloud Connector feature, now supports on-premises DB2 AS/400 as a data source.

  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * Acumatica (Fix): Fixed an issue where customers could not update their connection properties.
  * Oracle Service Cloud (Update): Connector updated to the latest version.
  * Power BI XMLA (Update): Connector updated to the latest version.
  * Zoho CRM (Update): Connector updated to fix a reauthentication issue.
</Update>

<Update label="March 13, 2026">
  ### What's New

  Connect AI now offers support for users to register custom OAuth applications for client integrations. Create custom OAuth apps in the **Settings** page of Connect AI.

  <Frame>
    <img alt="" />
  </Frame>

  ### Changes, Improvements, and Bug Fixes

  #### General

  * In the Private Cloud Connector feature, references to `cloudagent` or `onprem` have been changed to `connectgateway`.

  #### Connectors

  * Acumatica (Update): Connector updated to resolve customer issue with date filter.
  * Sage Intacct (Update): Connector updated to resolve customer issue.
  * SAP Gateway (Update): Added support for per-user authentication credentials, in addition to shared credentials.
  * Vertica (New): New connector added to Connect AI.
</Update>

<Update label="March 6, 2026">
  ### What's New

  Private Cloud Connector is now available for Connect AI. The gateway acts as a bridge between your on-premises data (not in the cloud) and Connect AI. It allows Connect AI to access your data without exposing your data directly to the internet.

  The gateway is installed as a Docker container and acts as a secure reverse tunnel between the data behind your company's firewall, private network, or Virtual Private Cloud (VPC) and the Connect AI cloud-based services.

  Connect AI supports the following connectors with Private Cloud Connector, with more to come:

  * Databricks
  * MySQL
  * PostgreSQL
  * SAP Gateway
  * Snowflake
  * SQL Server

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Users can now switch from single sign-on to email login.

  #### Connectors

  * Klaviyo (New): New connector added to Connect AI.
  * SAP Gateway (New): New connector added to Connect AI.
  * Snowflake (Update): Data source updated to fix an OAuth authentication issue.
</Update>

<Update label="February 27, 2026">
  ### What's New

  SCIM (System for Cross-domain Identity Management) 2.0 is now supported. SCIM is a standard for managing user provision, update, and deletion in cloud-based applications. To enable SCIM in your organization, contact [CData Support](https://www.cdata.com/support/).

  Private IP addresses are now permitted for on-premises connections.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * The Google Sheets add-on now supports parameterized queries.

  #### Connectors

  * Avalara (Update): Data source updated to the latest version.
  * DB2 (Update): Data source updated to the latest version.
  * Smartsheet (Update): Data source updated to the latest version. User-defined credentials are now available for Smartsheet.
  * Snowflake (Update): Data source updated to the latest version.
  * Xero (Update): Data source updated to the latest version.
</Update>

<Update label="February 20, 2026">
  ### What's New

  In Connect AI Embed, parent account administrators can now add, edit, and delete connection configuration overrides for end users, ensuring consistent configurations across sub-accounts. For example, you can override an account's OAuth sign-in credentials so that end users must use their own organization's credentials rather than CData credentials.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue where a new alias causes an error and prevents the loading of columns in the user interface.

  #### Connect AI Embed

  * Added a Read Only role for Connect AI Embed administrators.

  #### Connectors

  * Blackbaud Raiser's Edge NXT (Update): Data source updated to the latest version.
  * PostgreSQL (Update): Data source updated to the latest version.
</Update>

<Update label="February 13, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added GitHub Copilot as an AI integration tool.
  * Improved error messages in Excel Add-in.

  #### Connectors

  * Azure Synapse (Update): Data source updated to the latest version.
  * Dropbox (New): New connector added to Connect AI.
  * Google BigQuery (Fix): Fixed an issue that prevented OAuth authentication.
  * NetSuite (Update): Data source updated to the latest version.
</Update>

<Update label="February 6, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * TDS updated to latest version to fix a PowerBI issue.
  * Fixed an issue where column names that included square brackets were not returning data properly.
  * Added an `executeProcedure` tool to Data Copilot.

  #### Connect AI Embed

  * As part of ongoing improvements to the Connect AI Embed product, added the ability to add, edit, and delete sub-accounts in the user interface.
  * The External Id is now visible for sub-accounts.
  * The Audit logs also contain the Connect AI Embed parent account.

  #### Connectors

  * Business b-ridge (New): New connector added to Connect AI.
  * HubSpot (Update): Connect AI and Custom AI Embed users now have access to custom OAuth credentials.
</Update>

<Update label="January 30, 2026">
  ### What's New

  In the Google Sheets add-on, you can now edit queries using the Query Builder wizard.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Replit as an AI integration tool.
  * Fixed an issue that caused an error when derived views were executed asynchronously.
  * Data Copilot queries now terminate after four minutes and direct user to run the query in Data Explorer.

  #### Connect AI Embed

  * Improved the user interface for Connect AI Embed, including adding an Accounts page containing a list of sub-accounts.
  * Added a Logs page of sub-accounts for administrators to review.
  * The dashboard now displays rollup summary data for all sub-accounts, as well as data for individual sub-accounts.

  #### Connectors

  * All data sources are now updated to V25.
  * QuickBooks (Update): New custom report user interface released.
</Update>

<Update label="January 23, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added support to migrate connections from V24 to V25.
  * Improved error messages in Data Copilot.

  #### Connectors

  * Gmail (Update): Data source updated to the latest version.
  * Google Sheets (Update): Data source updated to the latest version.
  * Sage Intacct (Update): Data source updated to the latest version.
  * Square (Update): Data source updated to the latest version.
  * Zoho Books (Update): Data source updated to the latest version, which had significant differences in the data model compared to the current version.
</Update>

<Update label="January 16, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added LlamaIndex as an AI integration.
  * OData API now supports the X-HTTP-METHOD header translating a POST request to UPDATE.
  * Fixed an OData issue where NULL values were translated as empty strings.

  #### Connectors

  * REST (Update): Data source updated to the latest version.
  * Veeva Vault (Update): Data source updated to the latest version.
  * Exchange (Update): User-defined credentials, or UDC, now enabled.
</Update>

<Update label="January 9, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added the following AI integrations: LangGraph, Cursor, Claude Code, and Windsurf.
  * Removed sub-account API access for Connect AI Embed administrators.
  * Fixed an issue with merging SSO accounts.

  #### Connectors

  * ADP (Update): Data source updated to the latest version, and now includes the new WorkersLeaves view.
  * Azure Analysis Services (Fix): The URL can now start with the prefix `asazure://`.
  * Bullhorn CRM (Update): Data source updated to the latest version.
</Update>

<Update label="January 2, 2026">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * In the Excel Add-in and the Google Sheets add-on, fields returned in the Query Builder now appear in the order returned by the source connector, rather than in alphabetical order.
  * In the Excel Add-in, fixed an issue when executing a query in the SQL editor where there was a formula in a null column.
</Update>

<Update label="December 26, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The `OR` operator is now supported in the Google Sheets query builder.

  #### Connectors

  * Azure Analysis Services (Update): Data source updated to the latest version.
  * REST (Update): Data source updated to the latest version.
  * Sybase IQ (Update): Data source updated to the latest version.
</Update>

<Update label="December 19, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Agent Bricks added as an AI integration.
  * Broken connections can now no longer be selected on Data Explorer, Workspaces, or Jobs pages.
  * Google Sheets add-on Refresh feature updated to reflect multiple databases or derived views.

  #### Connectors

  * ADP (Fix): You can now save connections even if they do not authenticate.
  * API Connector (Fix): Fixed issue with adding repeat elements to a table.
  * Exchange (Update): Data source updated to the latest version.
  * Odoo (Update): Connect AI now supports connectivity to Odoo self-hosted. Data source also updated to the latest version.
  * Xero (Update): Added support for executing the CustomReportSchema stored procedure. Data source updated to the latest version.
</Update>

<Update label="December 12, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed comparison operators when using the OData API.

  #### Connectors

  * API Connector (Fix): Fixed issue when unrelated square brackets are passed along with body filters in the request body.
  * Veeva Vault (Update): Data source updated to the latest version.
</Update>

<Update label="December 5, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed the issue that occurred when SCALE for VARCHAR was null. The Data Explorer no longer returns an error message.

  #### Connectors

  * ADP (Update): Exposed ThrowsKeyNotFound property to fix a customer issue.
  * GraphQL (Update): Data source updated to the latest version.
  * NetSuite SuiteAnalytics (Update): Data source updated to the latest version.
  * ServiceNow (Update): Data source updated to the latest version.
</Update>

<Update label="November 21, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Query Federation support for Connect AI Embed users.
  * In the Excel Add-in, added a **Settings** option that allows users to link to their account settings in Connect AI.
  * Fixed an issue where the Excel Add-in omitted columns in a generated query when using the search filter.

  #### Connectors

  * eBay (Fix): Fixed an issue with using queries containing EXISTS.
  * LinkedIn (Update): Data source updated to the latest version.
  * Netsuite (Fix): Fixed toggle switches for parameters in custom reports not behaving as expected.
  * Sybase IQ (New): Sybase IQ connector added to Connect AI.
  * Veeva Vault (Update): Data source updated to the latest version.
</Update>

<Update label="November 14, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * In the Google Sheets add-on, fixed an issue with updating and inserting time and date columns.
  * In Connect Spreadsheets, fixed an issue that prevented users from adding query results to a new page.
  * The Connect AI LLM was updated to recognize read-only fields.

  #### Connectors

  * API Connector (Update): Added support for dynamic filters in the request body.
</Update>

<Update label="November 7, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * In the Excel Add-in, sales and support email addresses now change dynamically by region.
  * The MCP (Model Context Protocol) definition was updated to optimize MCP performance.

  #### Connectors

  * API Connector (Update): Data source updated because of a parameter casing issue.
  * API Connector (Update): You can now use semicolon-delimited parsing for CSV endpoints.
  * SAP SuccessFactors (Update): Data source updated to the latest version.
  * Xero (Update): You must now use PKCE authentication. Other authentication options were removed.
</Update>

<Update label="October 31, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added scheduled queries to the drop-down list on the **Jobs** page.

  #### Connectors

  * ADP (Update): Data source updated to the latest version.
  * DB2 (New): DB2 connector added to Connect AI.
  * Neo4j (New): Neo4j connector added to Connect AI.
  * QuickBooks Online (Update): Users informed in the documentation that Intuit is now charging for API calls authenticated through partner-issued credentials. Therefore, users are strongly encouraged to create their own OAuth credentials through the Intuit developer portal.
  * Smaregi (Update): Data source updated to the latest version.
</Update>

<Update label="October 24, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * In the Excel Add-In, the OR operator is now supported within the Query Builder.
  * In the Google Sheets add-on, fixed an issue where Google rejected a user with a missing last name.
  * In the Job endpoint of the API, added a generic params field that works for both scheduled query and cache jobs.

  #### Connectors

  * API Connector (Update): Added CSV as a supported response type.
  * Databricks Lakebase (New): Lakebase connector added to Connect AI.
  * Jira (Update): The Jira connector now supports user-defined credentials.
  * Sage Intacct (Update): Data source updated to the latest version. Also added support for OneLogin authentication.
  * Xero (Update): Data source updated to the latest version.
</Update>

<Update label="October 17, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue with the TDS endpoint that led to an error importing data into FileMaker Pro.
  * In the Google Sheets add-on, made the following updates and fixes:
    * Added the ability to collapse and expand queries in the refresh menu.
    * Added a **Refresh** button for both query and audit logs in the **Log** function.
    * Fixed an issue where read-only columns were being included in Update queries.

  #### Connectors

  * Cvent (New): Cvent connector added to Connect AI.
  * Jira (Update): Data source updated to the latest version.
  * MySQL (Update): Data source updated to the latest version.
  * QuickBooks Online (Update): Data source updated to the latest version.
</Update>

<Update label="October 10, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * In the Excel Add-in, added the last date and time of refresh to the refresh screen.
  * In the Excel Add-in, fixed an issue with inserting timestamps in timestamp columns.

  #### Connectors

  * NetSuite (Update): This connector now has user-defined credentials enabled.
</Update>

<Update label="October 3, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Mistral Le Chat as a client tool.
  * In Data Explorer, you can now copy the contents of the SQL Editor to your clipboard.
  * When you click the documentation icon, you now see documentation related to your specific product.
  * Fixed an issue that prevented CData Connect Spreadsheets users from upgrading their plan.
  * Updated the response format for the getColumns MCP tool.

  #### Connectors

  * SAP SuccessFactors (Update): Data source updated to the latest version.
  * Sage Intacct (Update): Data source updated to the latest version.
  * Veeva Vault (Fix): Fixed an issue related to WHERE clause handling in queries.
</Update>

<Update label="September 26, 2025">
  ### What's New

  **Connect Cloud is now Connect AI.** This emphasizes our commitment to helping users connect to their data through modern AI technologies.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added CData Sync as a client tool.
  * Added CrewAI as a client tool.
  * Added ChatGPT as a client tool. Users must use the Developer mode of ChatGPT.
  * Fixed an issue with CData Excel functions in the Excel Add-in.
</Update>

<Update label="September 19, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Connect AI users now have the option of changing to a CData Connect Spreadsheets plan on the billing update page.
  * You can no longer add a “.” when setting or editing a workspace name.

  #### Connectors

  * Pipedrive (New): Pipedrive connector added to Connect AI.
  * WooCommerce (Update): Data source updated to the latest version.
  * Outreach (Update): Data source updated to the latest version.
  * Paylocity (Update): Data source updated to the latest version, fixing pagination issues in PayStatementDetails.
</Update>

<Update label="September 12, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * QuickBooks (Update): Data source updated to the latest version.
  * Presto (Update): Data source updated to the latest version.
</Update>

<Update label="September 5, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue when importing a large number of records (50,000+) into Google Sheets.
  * Added MCP (Model Context Protocol) as a client tool.

  #### Connectors

  * Sage Intacct (Fix): Fixed an issue where jobs were failing in the GL Detail table.
</Update>

<Update label="August 29, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Auto-refresh is now enabled on cache jobs.

  #### Connectors

  * QuickBooks (Update): Data source updated to the latest version.
  * MongoDB (Update): Data source updated to the latest version.
  * MYOB (Update): Data source updated to the latest version.
  * Sage Intacct (Update): Data source updated to the latest version.
  * Query Federation (Update): Data source updated to the latest version.
  * NetSuite (Update): Data source updated to the latest version.
</Update>

<Update label="August 22, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * When a user opens Google Sheets and has already run a query on a sheet, the add-on opens on the Import function preloaded with the previous SQL query.
  * The application logos have been updated for CData Connect Spreadsheets and Powered by CData users.
  * Canceled account users can now use the self-service feature.

  #### Connectors

  * Facebook and Facebook Ads (Update): Data sources updated to the latest version.
  * Garoon (New): Added Garoon as a new connector for Connect AI.
  * SAP Fieldglass (New): Added SAP Fieldglass as a new connector for Connect AI.
  * Snowflake (Update): Data source updated to the latest version.
</Update>

<Update label="August 15, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Deletes in MCP are disabled for now for security reasons. This is to prevent AI from inadvertently deleting data from a source system.
  * The Excel Add-in now includes the `CDATACONNECT.INSERT` function.
  * Fixed an issue where the CONTAINS function failed in the Query Builder for MySQL databases.

  #### Connectors

  * API Connector (Update): You can now receive responses from tables other than plain text, such as JSON objects.
  * Bullhorn CRM (Update): Data source updated to the latest version.
  * MySQL (Update): Data source updated to the latest version.
  * QuickBooks Online (Update): Data source updated to the latest version.
</Update>

<Update label="August 8, 2025">
  ### What’s New

  * Unlock the power of your data with AI. Introducing Claude connectivity to Connect AI. Once you connect Claude to Connect AI, you can ask natural-language questions to obtain insights about your data.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * In the Excel and Google Sheets add-ins, Virtual Datasets has been renamed to Workspaces in the Import From drop-down list.
  * Fixed an issue where user accounts made through SSO failed to merge when the email address included capital letters.

  #### Connectors

  * Odoo (Fix): Fixed an issue with the field ‘groups\_ids’.
  * Sage Intacct (Update): Data source updated to the latest version.
  * Sage Intacct (Fix): You can now group custom reports.
  * SAP SuccessFactors (Update): Data source updated to the latest version.
  * Zoho CRM (Update): Data source updated to the latest version.
</Update>

<Update label="August 1, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added AWS App Studio as a client tool.
  * Added an error page for SSO users who create an account when one already exists in their domain.
  * Fixed an issue with the Google Sheets add-on where CData Connect Spreadsheets users could not access Virtual Datasets or Derived Views.
  * Improved the performance of update operations in the Google Sheets add-on.
  * Fixed an issue with the Google Sheets add-on where auto-refresh could not refresh multiple spreadsheets.

  #### Connectors

  * Amazon Marketplace (Update): Data source updated to the latest version.
  * NetSuite (Update): Data source updated to the latest version.
  * NetSuite (Update): Exposed the Preferred Date Formats property in the Advanced Settings of the NetSuite Add/Edit Connection page.
  * LinkedIn and LinkedIn Ads (Update): Data source updated to the latest version.
</Update>

<Update label="July 25, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue regarding the Imported Keys endpoint in the metadata API.
  * Microsoft Fabric is now available as a client integration tool.

  #### Connectors

  * Acumatica (Update): Data source updated to the latest version.
  * Google Ad Manager (Update): Data source updated to the latest version.
  * GraphQL (Update): Data source updated to the latest version.
  * Query Federation (Update): Data source updated to the latest version.
  * Shopify (Update): Data source updated to the latest version.
</Update>

<Update label="July 18, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * Jira (Update): Data source updated to the latest version.
  * Query Federation (Update): Data source updated to the latest version.
  * SQL (Update): Data source updated to the latest version.
  * Veeva Vault (Update): Data source updated to the latest version.
</Update>

<Update label="July 11, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Updated the list of connectors that require prerequisites. The user is informed that prerequisites are required in the connector’s Add/Edit page.

  #### Connectors

  * Google Ads (Update): Data source updated.
  * NetSuite (Update): Data source updated to the latest version.
</Update>

<Update label="July 4, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added the ability to rename tabs in the Data Explorer (not applicable for derived views or saved queries).
  * The Data Explorer now displays the column size in the column details.

  #### Connectors

  * Adobe Analytics (Update): Data source updated to the latest version.
  * Exact Online (Update): Data source updated to the latest version.
  * Query Federation (Update): Data source updated to the latest version.
</Update>

<Update label="June 27, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added the ability to search for and select one or more users in the **Logs** page.

  #### Connectors

  * Jira Assets (New): Connector added to Connect AI.
  * Monday (Update): Data source updated to the latest version.
  * Sage Intacct (Update): Data source updated to the latest version.
</Update>

<Update label="June 20, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue where long-running queries time out on Google Sheets and Excel Add-ins.
  * The Google Sheets and Excel Add-ins now displays the data model when setting up connections.
  * Fixed an issue where the Google Sheets add-on was exceeding Google’s daily quota on data storage.

  #### Connectors

  * Okta (New): Connector added to Connect AI.
  * Act! CRM (Update): Data source updated to the latest version.
  * MYOB (Update): Data source updated to the latest version.
  * Instagram (Update): Data source updated to the latest version.
  * HubSpot (Update): Data source updated to the latest version.
</Update>

<Update label="June 13, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Powered by CData users can now preview the data when adding or modifying a connection.

  #### Connectors

  * Databricks (Update): Support for querying primary keys/foreign keys in Powered by CData.
  * Databricks (Update): Data source updated to the latest version.
  * Google Ads (Update): Data source updated to the latest version.
</Update>

<Update label="June 6, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * In Data Explorer, typing an entity name with only an opening bracket, then selecting a suggestion from the autocomplete terms, no longer causes an error.
  * Customers can now change the organization name in Account Settings.
  * The Powered by CData Administrator can now control whether users can view the data model after they add a connection.

  #### Connectors

  * Highrise (New): Connector added to Connect AI.
  * Sage Intacct (Update): Data source updated to the latest version.
  * MYOB (Update): Data source updated to the latest version.
  * Bullhorn CRM (Update): Data source updated to the latest version.
</Update>

<Update label="May 30, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue with Google Sheets add-on where execution time limit was exceeded.
  * Fixed an issue with the TDS endpoint where it did not return data in certain cases.
  * The Google Sheets add-on now supports truncation when the value exceeds 50,000 characters.

  #### Connectors

  * NetSuite SuiteAnalytics (New): Connector added to Connect AI.
  * API Connector (Update): Removed Beta tag from this connector.
  * API Connector (Update): Columns stay selected in the configure wizard after setup.
  * Bullhorn (Update): This connector now supports the OAuth Password authentication scheme.
</Update>

<Update label="May 23, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * You can now delete connections directly in the Google Sheets add-on or the Excel Add-in.
  * Fixed an issue with automatic refresh in the Google Sheets add-on.
  * Partial rollout of new query metadata service.

  #### Connectors

  * MariaDB and PostgreSQL (Update): Added support for TLS 1.3.
  * Blackbaud Raisers Edge and Blackbaud Financial Edge (Update): Updated authentication instructions for these connectors. Also exposed Redirect URI to support custom OAuth applications.
</Update>

<Update label="May 16, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The QuickBooks Online connection now displays templates of common queries you can use. Click **Execute Query** to view and execute the query in Data Explorer.

  #### Connectors

  * API Connector (Update): Added support for LDJSON (line-delimited JSON).
</Update>

<Update label="May 9, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * You can now add and modify connections directly in the Google Sheets add-on or the Excel Add-in.
  * In the Data Explorer, when you open a derived view, you can now view the derived view’s details.
  * Enhancement to Query Service that continuously streams data, better handling slower APIs.
  * Excel Add-in fix for tables with spaces in their names.
  * Excel Add-in tooltip informing users that the update and delete options are not valid for data from a view.
  * The Google Sheets add-on retains the existing formatting when refreshing an existing table.
</Update>

<Update label="May 2, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The **Client Tools** page is now **Integrations**.
  * In the Data Explorer, the auto-complete feature now includes keywords specific to Connect AI. You can also hover over a function to view a description of the function.
  * In the Data Explorer, you can now close all Query Builder and SQL Editor tabs at once.
  * In the Google Sheets add-on, you can now select an auto-refresh interval for specific sheets.
  * In the Google Sheets add-on, users receive a warning if the cell’s contents exceed Google’s limit. The add-on then truncates the entry.
  * The Excel Add-in now preloads the previously run query upon opening. If no query was run previously, the Add-in loads at an empty state.
  * Updated names of Excel functions so it is clearer they are Connect AI functions, for example, `CDATACONNECT.DELETE`.

  #### Connectors

  * Dynamics CRM (New): Connector added to Connect AI.
  * API Connector (Update): Added a new authentication scheme: OAuth Password.
  * Snowflake (Fix): You can now query tables with the same name, but different cases (such as `TABLE` and `table`), in a schema. They are recognized as two different tables.
</Update>

<Update label="April 25, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Improvements to the user interface that better explain errors and next steps for users.
  * When users make a change to a connector configuration that requires the user to sign in (such as OAuth), they should not be able to save and test until they sign in again.
  * The **Virtual Datasets** page is now **Workspaces**.
  * Google Sheets add-on and Excel Add-in users can now see the list of Connect AI connections and their statuses.
  * The Workspaces now includes better messaging for various scenarios, such as loading workspaces, bulk adding datasets, and bulk deleting datasets.
  * Removed the Manage Payment Method button when the user is on a trial version.
</Update>

<Update label="April 18, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The Excel Add-in now includes the function CDataUpdate, which can update data.
  * The **Overview** page is now **Dashboard**.
  * Update to the Terms of Service. The Terms of Service is now displayed automatically when users sign up or when the terms are updated.

  #### Connectors

  * Instagram (Fix): Fixed an issue with date-filtered query.
</Update>

<Update label="April 11, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Updated the user interface for the bulk deletion of users, making it easier to see which ones were successfully deleted.

  #### Connectors

  * API Connector (Update): API connector now allows selecting pseudocolumns in the **Filters** tab.
  * Acumatica (Update): The REST schema now exposes the Company field.
</Update>

<Update label="April 4, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Excel Add-in now supports the function CDataDelete, which can delete data.
  * Fixed an issue where SSO users were not receiving invitation or verification emails.

  #### Connectors

  * MongoDB (Fix): Fixed an issue with schema and table visibility in Looker Studio.
  * Azure Data Lake Storage (Fix): Fixed a connection issue that involved a firewall.
</Update>

<Update label="March 28, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Improved the billing plan information for customers that more clearly displays the features of the current plan and the available upgrade plans.

  #### Connectors

  * API Connector (Fix): Fixed an issue with columns not displaying in the configuration wizard.
</Update>

<Update label="March 21, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * You can now access documentation and CData community resources directly from the Excel Add-in and the Google Sheets add-on.
  * Fixed an issue with creating derived views when queries are running in parallel.
  * Fixed a PowerBI.com client tool issue that affected publishing to PowerBI.com with DirectQuery mode.

  #### Connectors

  * API Connector (Fix): Fixed an issue with POST requests returning an error.
  * QuickBooks Online (Fix): Fixed an issue with querying the ProfitAndLossSummaryReport.
</Update>

<Update label="March 14, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The Excel Add-in now includes the Excel function CDataQuery, which can query connections.
  * Connections are now called Sources in the user interface.

  #### Connectors

  * SQL Server (Update): The Azure Tenant field is now available when Azure AD is the authentication scheme.
</Update>

<Update label="March 7, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Created an onboarding checklist for new users.
  * The Queries, Audit Events, and Query Log APIs are now available to non-OEM customers.
  * Renamed items in the Connect AI navigation panel to make them easier for users to understand.
  * Added a Permissions tab to Workspaces, similar to the one used in Sources. This allows for workspace-level permissions.
  * You can now access the CData Community directly from the CData Connect Spreadsheets add-ins.
  * Tables in the Excel Add-in now retain the column order from the original schema.

  #### Connectors

  * Greenhouse (New): Added Greenhouse as a new connector for Connect AI.
  * Zoho Projects (Fix): The Portal ID is now dynamically populated in the Add Connection page.
</Update>

<Update label="February 28, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Updates to the way data is displayed in the **Logs** page.
  * Powered by CData Connect users can now view the status of their connections through the API.

  #### Connectors

  * Snowflake (Fix): Database is now correctly designated as required when you add this connector.
  * Xero (Update): Customers can now more finely control the precision of the UnitAmount attribute in Invoices.
  * Databricks (Fix): There is now a **Sign In** button when you add a connection using the OAuthU2M authentication scheme.
  * SageIntacct (Update): Embedded credential supports writes now.
  * Zoho CRM (Fix): Fixed ORDERBY when using RecordsAPI.
</Update>

<Update label="February 21, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The Excel Add-in update feature now updates only changed columns.
  * Fixed issue in Data Explorer where queries with UNION and JOIN combined with SELECT were not returning results.
  * Fixed issue with OAuth app sign-in functionality when reconnecting.

  #### Connectors

  * Workday (Fix): Fixed issue where callback URL was incorrect when trying to connect.
</Update>

<Update label="February 14, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Google Apps Script as a client tool.
  * The SQL Editor in Data Explorer now auto-loads related column names for a given table into a drop-down list.
  * The user interface now distinguishes between tables and views more clearly.

  #### Connectors

  * Amazon Marketplace (Update): Users can now create custom reports with this connector.
  * Salesforce (Fix): Fixed batch updates feature for API V2.
  * Salesforce (Update): Updated to latest data source version.
  * PostgreSQL (Update): Updated to latest data source version.
</Update>

<Update label="February 7, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * In Data Explorer, you can now search for schemas and tables in the search bar once you select a connection.
  * Added User Credentials feature for RedShift.
  * The following development tools were updated on the Integrations page: Python, ADO.NET, JDBC, ODBC, and SSIS.
  * The user’s first and last name are filled in automatically when signing up with single sign-on (SSO).
  * In the Data Explorer, you can now save non-SELECT SQL statements as a Saved Query, Scheduled Query, or Derived View.
  * Improved logging for the Scheduled Queries feature.
</Update>

<Update label="January 24, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * In the Data Explorer, users can now choose between Query Builder or SQL Editor when adding a new tab.
  * The Data Explorer now displays a primary key icon in the details tab to identify the primary key column.
  * Scheduled Queries now has a **Stop Run** button.

  #### Connectors

  * Zoho Inventory (Fix): Fixed a bug that was impacting user connections.
</Update>

<Update label="January 17, 2025">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * In the Excel Add-in, you can now modify a query in the refresh menu.
  * Added User Credentials feature for Monday and SharePoint.
  * In the Data Explorer, you can now cancel running queries.
  * Fixed an issue with the Salesforce User Credentials feature.
  * Fixed an issue with Scheduled Queries where RedShift was the destination connection.
  * CData Connect Spreadsheets: Updates in the Excel Add-in now work with Boolean fields.
</Update>

<Update label="January 10, 2025">
  ### What’s New

  * Connect AI has introduced a new starter plan, which includes all client tools.
  * Connect AI has increased AI credits from 20 to 100 for paying users.
  * You can now access the CData Community and ask questions directly within Connect AI.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * You can now save an incomplete connection. The connection appears as Not Authenticated, and you can complete authentication later.
  * The Data Explorer has an improved user interface that makes it easier to expand and collapse schemas to find the desired tables and views.
  * The Data Explorer now has a Home button for easier navigation. The Home button returns you to a page where you can select either Query Builder or SQL Editor.
  * The Data Explorer now shows the entire Query Builder wizard upon selecting an item.
  * Improved search capabilities across the CData website. Use the search icon to search the documentation as well as related topics on the CData website.
  * Improved user interface for the Add Connections page, allowing for easier searching and scrolling through the list of connections.
  * Improved user interface for the Connections page, allowing for easier searching and pagination of large connection lists.
  * The connection setup documentation is now always available on the Add/Edit Connection pages as a sidebar for quick reference.
  * Connect AI now offers OpenAPI support for Microsoft Power Automate.
  * CData Connect Spreadsheets now displays a message when users have reached their connection limit and will be unable to create a new connection.
  * You can now load tables containing “, #, or & in their names into the Excel Add-in.
  * The API Connector now allows POST requests.
  * You can now manually update cells containing floats in the Excel Add-in.

  #### Connectors

  * NetSuite (Improvement): Improvement of error messages for connection errors.
</Update>

<Update label="December 13, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Improved the user interface for the Client Tools page.
  * Fixed issue with adding a filter in the Google Sheets add-on.
  * The Virtual Datasets page now includes connector icons to identify each asset in the workspace.
  * The user is now prevented from naming connections and workspaces the same, eliminating ambiguity in the Data Explorer.
  * Fixed issue with Zoho Creator updates in the Excel Add-in.

  #### Connectors

  * Google Drive (New): Added Google Drive as a new connector for Connect AI.
  * MongoDB (Improvement): Improved SQL filtering for certain data types.
  * NetSuite (Improvement): Improved OAuth connectivity.
</Update>

<Update label="December 6, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added User Credentials support for Paylocity, Sage Intacct, and Blackbaud Raiser’s Edge.
  * Improvement to refresh feature in Excel Add-in.
  * Improved error messaging in Excel Add-in when exceeding Excel’s alloted limit.
  * Improved log generation when updating multiple rows in Excel Add-in.
  * COUNT(\*) issue fixed in Data Explorer.
</Update>

<Update label="November 29, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Grafana as a client tool.
  * Improved Excel Add-in support for large datasets.
  * You can now update a nvarchar type in Excel Add-in.
  * Improved Data Explorer user interface for cells containing long values (option to truncate or scroll).
  * Fixed varchar casting for the Google Sheets add-on.
  * When an update fails in the Google Sheets add-on, the color of the changed fields now remains red, as expected.

  #### Connectors

  * Salesforce (Improvement): The default value for Include Reports is now True.
  * Dynamics 365 Business Central (Update): The property MinimumColumnSize is now available in Connect AI.
  * HubSpot (Update): The property ExpandAssociations is now available in Connect AI.
</Update>

<Update label="November 15, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The Query Builder now persists when navigating away from it and then returning.
  * Improvement in how OData truncates data types.
  * In the Excel Add-in, formula references now persist when you refresh the data.
  * The Google Sheets data changes back to black after a successful update.
  * `java.math.BigDecimal` class can now be cast to the `java.lang.Integer` class, as long as it is a specific column with a specific table in the data source.

  #### Connectors

  * ADP (Update): The connector now allows multiple filters on the ADP timecard table.
</Update>

<Update label="November 8, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Improved messaging with the Google Sheets batch update feature.

  #### Connectors

  * Dynamics 365 (Fix): Fixed an issue where Connect AI was not allowing incremental updates with caching.
  * Jira Service Management (Fix): Fixed an issue where the RequestSLACycles view was only returning service requests in which the configured user was a request participant.
</Update>

<Update label="November 1, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Minor user interface and logging improvements for the Google Sheets add-on.
</Update>

<Update label="October 25, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added new filter to the Looker Studio add-on to support filtering by email.
  * You can now connect Metabase to Connect AI via SQL Server.
  * SQL Server endpoint fix for large data volumes.

  #### Connectors

  * API Connector (Fix): Fixed an issue with OAuth 2.0 sign in.
</Update>

<Update label="October 18, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added ReTool and Axios as client tools.
  * Google Sheets add-on now performs batch record updates.
  * Incremental caching is now supported for all supported data sources.
  * Fixed an issue with OAuth connections for Excel Add-in for the Mac.
  * Minor user interface improvement for client tool endpoints.
  * Data now caches properly when you change the cache database.

  #### Connectors

  * Bullhorn CRM (Fix): Minor data source fix for queries.
  * Snowflake (Fix): Fixed Snowflake partner integration.
  * QuickBooks Online (Update): **Reconnect** changed to **Disconnect**, as per a compliance review.
</Update>

<Update label="October 11, 2024">
  ### What’s New

  * The onboarding wizard now gives new users different options after successfully setting up a connection.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Mode as a client tool.
  * Added Databricks as a client tool.
  * The Google Sheets add-on can now automatically determine primary keys and update the display.
  * You can now move assets between workspaces.
  * Fixed an issue with Power BI returning a null value.

  #### Connectors

  * API Connector (Update): Improved OAuth functionality for certain use cases.
  * API Connector (Fix): Fixed an issue related to connecting to NetSuite.
  * NetSuite (Fix): Fixed decimal value in account view.
</Update>

<Update label="October 4, 2024">
  ### What’s New

  * You can now navigate away from Data Explorer and return to your queries.
  * The Connections overview page now contains a connection status column.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Workato as a client tool.
  * You can now perform a single record update in the Google Sheets add-on.
  * Fixed an issue with jobs not caching.

  #### Connectors

  * Bullhorn CRM (Fix): Exposed a field to fix a connection issue.
  * Zoho Creator (Fix): Fixed an issue with IN condition.
  * OData Connector (Fix): URL validation fix.
</Update>

<Update label="September 27, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Zapier as a client tool.
  * UseSSL is now enabled for all relevant data sources.
  * The Google Sheets add-on improved the performance of inserting records by completing the update in batches.
</Update>

<Update label="September 20, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fixed an issue with the OpenAPI spec file.
  * Fixed an issue where SSO users were not able to invite others to their account.
  * The OData data source now contains the property Exclude Control Information Root Type.
  * The Google Sheets add-on now displays newly-updated cells in a different font color.
  * Fixed an issue for data sources that use the OAuth Client authentication scheme.
  * Changed the way federated queries are handled for sub-select queries. They are now executed as a dependent join instead of a merge join.
</Update>

<Update label="September 13, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added ThoughtSpot as a client tool.

  #### Connectors

  * Reckon Accounts Hosted connector (New): Reckon Accounts Hosted has been added as a new connector.
</Update>

<Update label="September 6, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * You can now perform a single record insert in the Google Sheets add-on.
  * You can now see which tables/views are being cached in the Data Explorer and in Virtual Datasets.

  #### Connectors

  * Zoho CRM (Fix): Fixed issue with retrieving Subforms for all records.
  * Sage Intacct (Fix): Fixed issue with Reportingbook field data.
  * NetSuite (Update): Exposed the rowscandepth property in the Advanced Settings tab.
</Update>

<Update label="August 30, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Jitterbit as a client tool.
  * Added Azure Logic Apps as a client tool.
</Update>

<Update label="August 23, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Connect AI now offers connectivity for the following client tools:
    * Redash
    * MicroStrategy
    * Node.js
  * Users can now specify local IP addresses so that SSH tunnels work.
  * Distinguished NULL values in data tables for better clarity.
  * Fixed issue in OpenAPI for tables with multiple primary keys.

  #### Connectors

  * SurveyMonkey (Improvement): Added an option to bypass SurveyMonkey API request limitations.
  * Amazon Redshift (Fix): Fixed logo.
</Update>

<Update label="August 16, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Connect AI now offers connectivity for the following client tools:
    * SnapLogic
    * SAP Crystal Reports
    * Metabase
  * OAuth Client authentication was added to the API Connector.
</Update>

<Update label="August 2, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * Xero (Fix): Fixed an issue where the PKCE authentication scheme was not working.
</Update>

<Update label="July 26, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The Overview page now contains the row count of data for each connection.

  #### Connectors

  * Query Federation (Fix): Fixed an issue where JOINs with derived views were failing.
  * MYOB (Improvement): The OAuthClientId and OAuthClientSecret fields are now exposed in the Connect AI settings.
  * SAP Success Factors (Improvement): The OAuthClientId and OAuthClientSecret fields are now exposed in the Connect AI basic settings. Also fixed an issue where the Learning API was returning errors.
  * JIRA (Fix): Changed the default authentication scheme to OAuth.
</Update>

<Update label="July 19, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Updated the Caching feature so that it is only allowed for certain data sources.
</Update>

<Update label="July 12, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Mulesoft as a client tool.
  * Added Salesforce External Services as a client tool.
  * Google Sheets add-on now provides users with the ability to remove scheduled queries from a spreadsheet.
  * Added ability to click on information in the **Overview** page to view details, such as query logs.
  * Corrected the link to the OpenAPI specification document in the workspace **Endpoints** dialog.
  * The metadata cache can now be refreshed per connection, instead of globally.
  * You can now adjust the width of the results columns in the Data Explorer.

  #### Connectors

  * QuickBooks Online (Fix): Fixed issue where custom reports were not displaying in Data Explorer. (Click **Save** again to get your custom report to appear.)
</Update>

<Update label="June 28, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * **API** was added to the main navigation bar to make it easier to navigate to the Connect AI SQL API.

  #### Connectors

  * Sage 300 (Update): Added Sage 300 as an available data source.
  * Tsheets (Improvement): Added support for Project Activities, Project Activity Read Times, Project Activity Replies, and Project Notes tables.
  * Zoho CRM (Update): Renamed Events to Meetings.
  * Sage Intacct (Fix): Fixed stored procedure for creating custom reports.
</Update>

<Update label="June 21, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Cloud Data Fusion as a client tool.
  * Google Sheets add-on now includes operator types of ‘greater than or equal to’ and ‘less than or equal to’.
</Update>

<Update label="June 7, 2024">
  ### What’s New

  #### OpenAPI Support

  <Frame>
    <img alt="" />
  </Frame>

  Connect AI now supports OpenAPI 2.0 and 3.0, allowing you to connect no-code/low-code applications that integrate with OpenAPI, such as Microsoft Power Apps. Go to Connect AI Virtual Datasets and download an OpenAPI specification (version 2.0 or 3.0) for the desired workspace. Then import the OpenAPI specification into your application and connect to your data.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added the ability to export Data Explorer results as a CSV file. Execute your query and click **Download CSV**.
</Update>

<Update label="May 31, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added Delete functionality to Google Sheets add-on.
</Update>

<Update label="May 24, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Excel Add-in now includes operator types of ‘greater than or equal to’ and ‘less than or equal to’.
  * Fixed an issue with the Virtual Dataset OData endpoint by prepending an underscore instead of replacing the first character.
</Update>

<Update label="May 17, 2024">
  ### What’s New

  #### Bubble

  You can now connect from Bubble to Connect AI with Bubble’s plugin.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Updated Excel Add-in to update tables with multiple primary keys. Also fixed column sorting to sort by primary key rather than alphanumerically.
</Update>

<Update label="May 10, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Excel Add-in now offers the option of viewing output in the current sheet or a new sheet.

  #### Connectors

  * ADP (Fix): Fixed issue retrieving columns from Workers Work Assignments.
</Update>

<Update label="May 3, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added support for the `$count` query string parameter to our OData service.

  #### Connectors

  * Amazon Marketplace (Fix): Fixed `SUM` and `FORMAT` queries for OrderMetrics view.
  * Monday (Fix): Fixed issue with parsing date values with times.
</Update>

<Update label="April 26, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Published an updated AWS Glue connector.
  * Added the following Excel Add-in enhancements:
    * Improved scrolling
    * Sortable column headers
    * Improved ability to select and deselect fields
    * Ability to reference internal Excel sheets and columns to SQL statements

  #### Connectors

  * Odoo (Update): Updated to return both id and name for an integer datatype column.
</Update>

<Update label="April 19, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added the ability to duplicate custom reports.
  * Fixed an issue in Excel for the web Add-in to allow users with a Mac to use Connect AI.

  #### Connectors

  * Netsuite (Update): Added support for custom segments.
  * LinkedIn (Update): Added the Organizations view for reading LinkedIn organizations’ data when you are not the admin for that organization, renamed the CompanyLocations view to OrganizationLocations, and renamed and added columns to the OrganizationLocations view.
</Update>

<Update label="April 12, 2024">
  ### What’s New

  #### Caching

  <Frame>
    <img alt="" />
  </Frame>

  Say goodbye to slow data connections with Connect AI’s new caching feature. The user selects tables to be cached, or saved to a database. Connect AI then fetches data for the selected tables on a scheduled basis, ensuring swift and reliable access to data whenever you need it.

  With caching, you no longer have to wait while the data source retrieves live data. When you enable caching on a table, Connect AI runs database queries against the *cached* data, not the live data.

  The caching feature allows for incremental updates, improving performance. When you create a cache job, Connect AI tries to find date or date+time columns in the database that show which rows are new or have changed since the last run. Connect AI can then run the cache job for those rows only. Otherwise, Connect AI runs a full update.
</Update>

<Update label="March 29, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Added ability to reference cells in other sheets in the Excel Add-in. As you change the values in the sheet, the Excel Add-in executes a new query. For example, the following filter criteria references the `@InputSheet!A2` parameter, which is cell `A2` of the sheet `InputSheet`. The `@` prefix indicates that Industry is a required parameter.

  ```sql theme={null}
  SELECT BillingState, Name FROM Account WHERE Industry = @InputSheet!A2
  ```

  * Improved the way in which a user selects columns for import in Excel for the web Add-in by allowing checkbox selection and sortable column headers.
  * The API Connector now displays the Callback URL for OAuth connection.
  * The API Connector has the added ability to specify custom repeat elements in the connector setup. This is an advanced feature that gives users more flexibility over controlling how data from the API is parsed.

  #### Connectors

  * PayPal (Fix): OAuth issue fixed.
  * Sage Intacct (Fix): Support for `LIMIT` functions fixed.
  * Zoho Projects (Fix): Fixed length string error with Projects table metadata.
  * Monday (Update): Users can now specify which API version to use to connect to Monday.com.
  * Oracle (Fix): Fixed an issue when listing tables where the selected schema was not being sent to Oracle and performance was impacted.
</Update>

<Update label="March 22, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * The Name field for Custom Reports has been moved to its own section for ease of identification and access.
  * The Virtual Datasets feature is now available for query users. Query users can access all the workspaces for which they have permission.
  * In Data Explorer, the comments are now working correctly in the SQL editor.
  * In Data Explorer, improved the error handling when saving a derived view that contains multiple columns with the same name. When attempting to create a derived view with this condition, consider using aliases for the common column names.

  #### Connectors

  * Sage Intacct (Fix): Fixed issue with AccountType table querying.
  * HubSpot (Fix): Fixed issue with WebAnalytics view where too much data was causing an error.
</Update>

<Update label="March 8, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fix: Fixed an issue when retrieving derived views in Azure Data Factory.

  #### Connectors

  * ADP (Update): Added support for using PEM certificates for TLS client authentication.
  * Blackbaud FE NXT (New): Blackbaud FE NXT has been added as a new connector.
  * NetSuite (Fix): Resolved a problem when querying tables using SuiteScript that returned no results.
</Update>

<Update label="March 1, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fix: Fixed an issue that prevented previewing API Connector tables with spaces in their names.
  * Fix: Fixed an issue preventing virtual dataset OData endpoints from being queried before the \$metadata endpoint was queried for the first time.
  * Fix: Fixed an issue with CASE statements when joining two tables.
</Update>

<Update label="February 23, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * ADP (Update): Added new connection property of SSLClientCertType.
  * HubSpot (Update): Added support for subqueries to the WebAnalytics table.
  * LinkedIn (Update): Added support for v2 of Legacy API.
  * Square (Fix): Fixed an issue authenticating to Square.
  * Zuora (Update): Added support for RevenueSchedule and PaymentMethodSnapshot.
</Update>

<Update label="February 16, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Update: Users can now create connections and sign up for a new account from the Excel Add-in.
</Update>

<Update label="February 9, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Update: v23 is now available for all connectors, with the exception of Query Federation.
  * New: SAS Viya is now supported as a client tool for Connect AI. SAS Viya is a leading platform for transformative analytics solutions in today’s data-driven landscape. With Connect AI, you can connect SAS Viya to live data from hundreds of different data sources.
  * New: You can now define primary keys for views in OData. This allows for better integration with tools like Salesforce Connect and SAP Analytics Cloud.
</Update>

<Update label="February 2, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Updated OData fix for Salesforce Lightning Connect so that OData entities which do not have any Key properties will always return a composite Key made up of all properties.

  #### Connectors

  * Twitter (Removed): We regret to inform you that this connector is currently unavailable. For more information or assistance, please reach out to our dedicated support team. Thank you for your understanding.
  * Dynamics CRM (Deprecated): Customers should instead use the Dynamics 365 connector when connecting to Dynamics CRM.
</Update>

<Update label="January 26, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Update: Added support for composite keys in OData entities.
  * Fix: Fixed an issue where OData queries against null literals were failing.
  * Update: Added a prompt to inform users when their pop-up blocker is preventing them from authorizing a connection in the Connections Settings page.
  * Fix: Fixed an issue on the Users tab to allow sorting by clicking on the column header.
  * Update: Added functionality to inform users how to access their data after successfully authenticating their connection.
  * Update: Users can now access virtual datasets in the Looker Studio plug-in.

  #### Connectors

  * Kintone (Fix): Resolved a problem when making LIKE queries to the Kintone connector.
  * Zuora (Update): Some views in Zuora were updated to work without providing specific date range criteria by not including the Id in the view. This is due to logic in Zuora’s API.
</Update>

<Update label="January 19, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fix: Fixed an issue in the Excel Add-in when updating a field that has a decimal type.
  * Fix: Resolved an issue in the Excel Add-in where it was incorrectly sending an INSERT command when the user was updating a document.
  * Update: Query users are now able to refresh the metadata cache for a connection in the Data Explorer.

  #### Connectors

  * ALL (Update): The custom reports tab is now disabled if you have not authenticated to the data source.
  * Xero (Update): Updated the login button for Xero to include Xero branding.
</Update>

<Update label="January 12, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Update: In the onboarding wizard, the documentation for the connection configuration page is displayed automatically to help users set up their connections.
  * Fix: Resolved an issue that could cause a Data Explorer error when querying data if the schema contained too much data.
  * Fix: Resolved an issue in the Excel Add-in where Update queries could fail.
  * Informational: Display a banner in the OData page, informing users that this page will be deprecated in the future, and that users should use the Virtual Datasets feature instead.

  #### Connectors

  * Netsuite (Update): Fixed an issue where search fields in saved search custom reports were returning empty values.
</Update>

<Update label="January 5, 2024">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fix: Resolved an issue in the Data Explorer where queries were timing out after 100 seconds.
  * Fix: Removed the Sign In button in the onboarding wizard from the connection pages when OAuth is not the default auth scheme.
  * Fix: Fixed an issue in our billing system so that failed queries are not counted against row usage.
  * Fix: Resolved an issue in the Excel Add-in where updates were not generating logs.
  * Update: Added support in the Excel Add-in to delete and update tables in a workspace.
  * Update: Updated our OData service to report more informational error messages to users when querying the service.

  #### Connectors

  * DocuSign (New): DocuSign has been added as a new connector.
  * Shopify (Update): Added support for the IN operator in the DELETE clause of the Shopify connector. This allows users to delete rows from the Excel Add-in and push those changes back into Shopify.
</Update>

<Update label="December 22, 2023">
  ### What’s New

  #### AI Generator

  <Frame>
    <img alt="" />
  </Frame>

  We have released a new feature called AI Generator. This innovative feature allows Connect AI to decode language naturally, comprehend nuances, and translate them into SQL queries seamlessly navigating through diverse data sources. The convergence of AI and ML technologies within the cloud-based data virtualization tool eliminates the need for intricate technical knowledge, simplifying and streamlining data connectivity across your organization.

  Connect AI Generator’s allure stems from its intuitive, user-centered design. The days of grappling with complex SQL queries are over. Imagine a business user asking, “Find me the highest growth customers compared to the same period last year.” AI Generator springs into action, translates the question into SQL instructions that tap into diverse sources, applies time-based filters, and presents insights.

  #### New Connector

  * Quickbase has been added as a new connector.

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Update: Added a prerequisites section to the docs that explains which IP ranges to whitelist for certain connection types.
  * Improvement: Improved the error handling of our OData service endpoint to include more information about failures, to facilitate easier problem diagnostics.
  * Fix: Resolved a problem with Databricks connections when using the Azure Service Principal auth scheme.

  #### Connectors

  * Databricks (Update): Moved catalog to the main settings page to support their release of Unity Data Catalog.
  * Excel (Fix): Resolved a problem where setting `TypeDetectionScheme` to ‘ColumnFormat’ resulted in incorrect data types being reported for some columns.
  * NetSuite (Fix): Fixed an issue when using SuiteQL where parsing a long value in the ‘externalid’ column from custom record lists resulted in an error.
  * Shopify (Update): Added support for deleting items from the Excel Addin.
</Update>

<Update label="December 15, 2023">
  ### What’s New

  #### Virtual Datasets

  <Frame>
    <img alt="" />
  </Frame>

  We have released a new feature called virtual datasets which is a data catalog that streamlines the accessibility of diverse data sources by applying an innovative way to manage your data. Virtual datasets provide a sleek way to organize, catalog, and control access to specific data in Connect AI. You can bundle related data items separately in a scalable way. Virtual datasets offer an intuitive and customizable organization scheme that streamlines data analysis across numerous business functions.

  The core functionality of virtual datasets provides a structured organizational scheme to access data items. Virtual datasets architecture is a data management approach that favors synergy across teams and reduces data silos. It establishes a powerful structured framework for organizations to treat their data as a product and provide access to their valuable data resources. As each business domain assumes responsibility for its respective data sources, teams are empowered to operate efficiently, collaboratively, and consistently with their data.

  ### Changes, Improvements, and Bug Fixes

  * Update: Added a prerequisite section in the Sage Intacct documentation to inform users how to connect to Sage Intacct from Connect AI.
  * Improvement: The Excel Add-in and Google Sheets Add-in both now escape column names when building queries. This allows columns with special characters to be used in select and filter criteria.
</Update>

<Update label="December 8, 2023">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Update: Improved the search bar behavior when navigating to different connections and folders.
  * Fix: Resolved an issue with user-defined connections where some users were unable to query the data source.
  * Excel Addin (Update): When selecting columns, the Excel Addin will now escape column names properly to avoid errors for columns with spaces.

  #### Connectors

  * NetSuite (Fix): Added two columns ‘zip’ and ‘addrphone’ to the `customerAddressbookEntityAddress` table.
  * NetSuite (Fix): Resolved an issue when filtering on the ‘IsYear’ column of the `accountingperiod` table was failing.
  * NetSuite (Fix): Fixed a problem where NULL results were being returned when querying a saved search with SUM, AVG, or MAX summary types.
  * PowerBI XMLA (Update): Power BI XMLA connector now supports multiple values for the Workspace property.
  * Sage Intacct (Fix): Fixed an issue when updating the ItemAggregate column of the Glbatch table.
</Update>

<Update label="November 17, 2023">
  ### What’s New

  Virtual SQL Server now supports connections from Dataverse.

  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * QuickBooks (Fix): Added support for empty values of enum types in custom reports for the QuickBooks Online connector. Instead of only being able to pick a single transaction type when creating a custom report, users have the option to provide an empty value to get a report that includes all transaction types.
</Update>

<Update label="November 3, 2023">
  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * Adobe Analytics (Fix): Fixed a problem causing the OAuth auth scheme to not work with Adobe Analytics.
  * API Connector (Fix): Resolved a problem where a NULL value was being returned when specifying a value from a JSON array as a column.
  * ZohoBooks (Fix): Corrected the data type for the ProductNumber column in the InvoicePayments view to be a varchar.
</Update>

<Update label="October 28, 2023">
  ### What’s New

  Two new connectors are live on Connect AI: Greenplum and Outreach.io.

  ### Changes, Improvements, and Bug Fixes

  #### Connectors

  * Airtable (Fix): Resolved an issue when loading tables from Airtable.
  * Azure AD (Fix): Fixed an issue when requesting metadata for some column types. In some cases, the isNullable field returned an invalid value.
  * Google BigQuery (Fix): Resolved an issue where the function JSON\_EXTRACT\_SCALAR was returning an unknown data type.
  * NetSuite (Fix): Fixed a problem when querying a saved search with a summation function. Queries using SUM, AVG, & MAX were incorrectly returning a null value for saved searches.
  * Sage Intacct (Improvement): The GLaccountNo column’s data type in the AccountBalance table has been changed to a string from a double.
  * Zuora (Fix): Resolved a problem when using a CASE WHEN statement in a GROUP BY clause.
</Update>

<Update label="October 20, 2023">
  ### What’s New

  Two new client tools are now supported on Connect AI: Google Data Fusion and Microstrategy.

  #### SQL API

  Connect AI now provides a full-featured API that can query data, perform batch operations, and execute stored procedures across all data sources configured in your account. Any REST-compatible application or client tool capable of creating HTTP requests can integrate with the API. For more information, see the [REST API docs](/en/API/REST-API).

  ### Changes, Improvements, and Bug Fixes

  #### General

  * Fix: Resolved a problem when editing a derived view while multiple derived views were open in the data explorer.
  * Improvement: Added a new success message when saving derived views.
  * Fix: Fixed a bug that was preventing users from making changes to derived views.
  * Improvement: Added support for creating derived views from JOIN queries that combine data from multiple data sources.

  #### Connectors

  * Exact Online (Fix): The connector was unable to authenticate for several regions in Europe.
  * Adobe Analytics (Fix): Resolved an issue when authenticating with an Adobe Analytics account. Adobe is deprecating their JWT authentication method in favor of their Server to Server authentication method.
</Update>

<Update label="October 13, 2023">
  ### Changes, Improvements, and Bug Fixes

  * Excel Add-in (Fix): Resolved a problem when updating values of type Integer from Excel back to the data source.
  * Excel Desktop (Improvement): Added support for the Excel Desktop client for Connect AI Starter Tier users. This client supports Excel macros.
</Update>

<Update label="October 6, 2023">
  ### Changes, Improvements, and Bug Fixes

  #### General

  * Improvement: Users can now change their email login.
  * Fix: Resolved an issue where logs from the test connection were not being properly generated for a short period of time.
  * Fix: Resolved a problem with custom reports where editing a report was not loading values.
  * Fix: Fixed an issue in the Excel Add-in client where auto-generated queries were missing single-quotes.

  #### Connectors

  * API Connector (Improvement): Added a Documentation link to the Add Table page to make it easier to navigate to the documentation when setting up tables.
  * API Connector (Improvement): Improved the table settings UX and added helper descriptions for some settings.
  * Fix: Fixed an issue in API Connector where trailing spaces in headers or parameters fields could result in invalid authentication.
  * Exact Online (Fix): Resolved an issue where the “Use Bulk API” setting was not being saved properly when turning it off.
  * QuickBooks Online (Alert): Resolved a problem where customer credentials became invalid. All customers were required to reauthenticate to QuickBooks after this change.
  * Snowflake (Fix): Resolved an issue where a metadata request for the SIGN function was returning an invalid data type.
  * Zuora (Fix): Fixed a problem in the Zuora connector which caused CASE WHEN inside of GROUP BY queries to fail.
</Update>

<Update label="September 29, 2023">
  ### What’s New

  #### API Connector

  CData is excited to announce a new and highly requested feature to improve your data integration and analysis experience: API Connector. You can now directly connect your own API to Connect AI.

  CData understands the value of making data available from various data sources, and we know that your proprietary APIs matter just as much as separate app connections. Our new API Connector is a powerful bridge between Connect AI and your custom and proprietary APIs. Now, you can connect to any cloud-based API that produces XML or JSON. You can run queries and even manage user access to your APIs right from your Connect AI account. The server-side filtering option can even improve execution speeds.

  ### Changes, Improvements, and Bug Fixes

  * Fix: Fixed an issue where PowerBI successfully connected over TDS but failed to retrieve data.
  * Fix: Fixed a problem with filters in OData where columns with boolean or datetime types were not being applied properly to the results. These filters were not resulting in failures but were not properly being applied as filters .
  * Fix: Fixed a bug where authentication was being refused when switching credentials in the Connect AI UI from a shared account to a personal one.
  * Fix: Fixed a bug related to complex Exact Online queries which caused the UseBulkAPI property inside a filter to freeze as True.
</Update>


# SCIM Groups
Source: https://docs.cloud.cdata.com/en/SCIM/SCIM-Groups

Use SCIM to standardize the process of provisioning groups of users to Connect AI, assigning roles, and removing groups from Connect AI.

SCIM group provisioning lets you manage Connect AI access by syncing groups from your identity provider (IdP). Groups synced from your IdP are read-only in Connect AI. Create, update, and delete groups in your IdP, and SCIM keeps Connect AI in sync.

## Prerequisites

* **SSO** must be configured on your Connect AI account.
* **SCIM Groups** must be enabled on your account. Contact [CData Support](https://www.cdata.com/support/submit.aspx) to enable SSO and SCIM groups.
* **Microsoft Entra ID license requirement** *(Entra ID only)*: Automated SCIM provisioning requires Microsoft Entra ID Premium P1 or P2 (included with Microsoft 365 E3/E5). Organizations on the Entra ID free tier cannot configure automated provisioning.

Connect AI supports SCIM group provisioning with the following identity providers:

* Microsoft Entra ID
* Okta Workforce Identity Cloud
* Custom IdP (configured via SAML or OpenID Connect)

The following SCIM providers are NOT supported:

* PingFederate
* Google Workspace
* Active Directory Federation Services (ADFS)
* Active Directory/LDAP

## Configure SCIM Group Provisioning in Your Identity Provider

The steps below walk through the full SCIM groups configuration for Microsoft Entra ID and Okta Workforce Identity Cloud.

<Tabs>
  <Tab title="Entra ID">
    <Note>
      Connect AI does not appear in the Entra application gallery. You must create a new application from the gallery.
    </Note>

    <Steps>
      <Step>
        From the [Microsoft Entra admin center](https://entra.microsoft.com), navigate to **Enterprise apps** > **+ New application**. Click **Create your own application**, enter a name for the application (for example, *Connect AI SCIM*), select **Integrate any other application you don't find in the gallery (Non-gallery)**, and click **Create**.
      </Step>

      <Step>
        In the navigation menu, under **Manage**, select **Properties**. Set **Assignment required** to **Yes** and click **Save**.
      </Step>

      <Step>
        In the navigation menu, under **Manage**, select **Users and groups**. Assign the users and groups you want to provision to Connect AI. When you assign a group, the users from that group are provisioned automatically.
      </Step>

      <Step>
        In the navigation menu, under **Manage**, select **Provisioning** and click **Get started**.
      </Step>

      <Step>
        Set **Provisioning Mode** to **Automatic**.
      </Step>

      <Step>
        Under **Manage**, select **Connectivity** and configure the following parameters:

        * **Tenant URL**—enter the SCIM endpoint URL provided by CData Support and append `?aadOptscim062020` to the end of the URL. This is Microsoft's recommended workaround for a known SCIM 2.0 issue.
        * **Secret Token**—enter the Bearer token provided by CData Support.

        Click **Test Connection**.
      </Step>

      <Step>
        Under **Manage**, select **Provisioning**, expand **Mappings**, and confirm that **Provision Entra ID Groups** is set to **Enabled**.
      </Step>

      <Step>
        Under **Manage**, select **Attribute Mapping**, then select the **Users** tab. In the row containing `mail` and `emails[type eq "work"].value`, click the Edit icon and configure the following:

        * Set **Match objects using this attribute** to **Yes**.
        * Set **Matching precedence** to **2**.

        Click **Apply** to save, then click **Save** on the Attribute Mapping page.

        <Note>If users in your organization do not have the `mail` attribute populated in Entra ID, edit the same row and change **Source attribute** to `userPrincipalName` to ensure the email field is always populated during provisioning.</Note>
      </Step>

      <Step>
        On the main Enterprise application page, select **Provision on demand**. Search for and select a user or group you assigned, then click **Provision**. Verify that the user or group appears in Connect AI.
      </Step>

      <Step>
        Under **Provisioning**, set **Provisioning Status** to **On** to begin provisioning all assigned users and groups. After groups appear in Connect AI, assign roles to the group. See [Access Role Assignments](#access-role-assignments).
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        In the Okta Admin Console, navigate to **Applications** > **Browse App Catalog**. Search for **(OAuth Bearer Token) Governance with SCIM 2.0** and click **Add Integration**. Set an **Application label**, uncheck **Display application icon to users**, uncheck **Browser plugin auto-submit**, then click **Next** and **Done**.
      </Step>

      <Step>
        From the application settings page, click the **Provisioning** tab and click **Configure API Integration**. Select **Enable API Integration**. Enter the following values provided by CData Support:

        * **SCIM 2.0 Base URL**—the SCIM endpoint URL (remove any trailing slash)
        * **OAuth Bearer Token**—the Bearer token

        Optionally click **Test API Credentials** to verify the connection, then click **Save**.
      </Step>

      <Step>
        Next to **Provisioning to App**, click **Edit**. Enable the following features:

        * **Create Users**
        * **Update User Attributes**
        * **Deactivate Users**

        Uncheck **Set password when creating new users**, then click **Save**.
      </Step>

      <Step>
        Under **Attribute Mappings**, use the **X** button to delete the following rows, which can cause issues during updates:

        * **Primary email type**
        * **Primary phone type**
        * **Address type**
      </Step>

      <Step>
        Select the **Assignments** tab. Click **Assign**, choose **Assign to Groups**, select the groups to provision to Connect AI, and click **Done**.

        <Note>You must assign the same groups to both the SCIM application and your SSO application in Okta.</Note>
      </Step>

      <Step>
        Select the **Push Groups** tab. Click **Push Groups** and select **Find groups by name** or **Find groups by rule**. Search for and select the groups to provision, then click **Save**. Okta pushes the group objects to Connect AI.
      </Step>

      <Step>
        After groups appear in Connect AI, assign roles to the group. See [Access Role Assignments](#access-role-assignments).
      </Step>
    </Steps>
  </Tab>
</Tabs>

## SCIM Groups User Provisioning and Deprovisioning

When a user is added to a synced group in your IdP, Connect AI automatically provisions them. There is no need for the user to verify via email. The new user inherits the access roles assigned to that group. See [Access Role Assignments](#access-role-assignments) for details on assigning access roles to groups. The new user is also assigned to the system role Query user. You change the system role later by editing the user in the **Users** tab.

<Frame>
  <img alt="SCIM groups edit user" />
</Frame>

When a user is removed from a synced group, they lose the access roles assigned to that group. If the user is a member of multiple synced groups, they retain access through their remaining group memberships. To fully deprovision a user, remove them from all synced groups in your IdP and then call `DELETE /users/{id}` from the Management API to revoke PATs and any direct role and permission grants. The user record is retained but the user can no longer sign in.

## Access Role Assignments

After groups are synced, you assign Connect AI access roles to groups in the **Groups** tab of the **Users** page:

<Frame>
  <img alt="Groups tab of Users page" />
</Frame>

All current and future members of the group automatically receive the assigned roles. A group can hold multiple roles, and the same role can be assigned to multiple groups.

When you remove a role assignment from a group, members who held that role solely through this group assignment immediately lose it. See [Roles](/en/Roles) for details on system and access roles.

The Connect AI [Audit Log](/en/Logs#audit-log) displays SCIM group provisioning, membership changes, and role assignment changes.

## Frequently Asked Questions

**Why is the Get Started button unavailable in the Entra Provisioning tab?**

The **Get Started** button is unavailable when you are viewing an SSO enterprise app that does not have a native Entra provisioning connector. This is expected for Connect AI. You must create a new application from the gallery. See [Configure SCIM Group Provisioning in Your Identity Provider](#configure-scim-group-provisioning-in-your-identity-provider) above.


# SCIM Users
Source: https://docs.cloud.cdata.com/en/SCIM/SCIM-Users

Use SCIM to standardize the process of granting and removing individual user access to Connect AI.

The System for Cross-domain Identity Management (SCIM) is a standard for managing user provisioning, updates, and deletions in cloud-based applications. It allows you to use your company's identity provider, such as Okta or Entra ID, to provision, update, and delete users securely in Connect AI.

## Prerequisites

* **SSO** must be configured on your Connect AI account before you can enable SCIM Users.
* **SCIM Users** must be enabled on your account. Contact [CData Support](https://www.cdata.com/support/submit.aspx) to enable SCIM Users.
* **Microsoft Entra ID license requirement** *(Entra ID only)*: Automated SCIM provisioning requires Microsoft Entra ID Premium P1 or P2 (included with Microsoft 365 E3/E5). Organizations on the Entra ID free tier cannot configure automated provisioning.

Connect AI supports SCIM provisioning with the following identity providers:

* Microsoft Entra ID
* Okta Workforce Identity Cloud
* Custom IdP (configured via SAML or OpenID Connect)

The following SCIM providers are NOT supported:

* PingFederate
* Google Workspace
* Active Directory Federation Services (ADFS)
* Active Directory/LDAP

## Configure SCIM User Provisioning in Your Identity Provider

When CData Support enables SCIM for your account, they provide a unique SCIM endpoint URL and Bearer token. Use these credentials to connect your identity provider to Connect AI.

The steps below walk through the full SCIM user configuration for Microsoft Entra ID and Okta Workforce Identity Cloud.

<Tabs>
  <Tab title="Entra ID">
    <Note>
      **Connect AI does not appear in the Entra application gallery.** Create a new application from the gallery.
    </Note>

    <Steps>
      <Step>
        From the [Microsoft Entra admin center](https://entra.microsoft.com), navigate to **Enterprise apps** > **+ New application**. Click **Create your own application**, enter a name for the application (for example, *Connect AI SCIM*), select **Integrate any other application you don't find in the gallery (Non-gallery)**, and click **Create**.
      </Step>

      <Step>
        In the navigation menu, under **Manage**, select **Properties**. Set **Assignment required** to **Yes** and click **Save**.
      </Step>

      <Step>
        In the navigation menu, under **Manage**, select **Users and groups**. Assign the users and groups you want to provision to Connect AI. When you assign a group, the users from that group are provisioned automatically.
      </Step>

      <Step>
        In the navigation menu, under **Manage**, select **Provisioning** and click **Get started**.
      </Step>

      <Step>
        Set **Provisioning Mode** to **Automatic**.
      </Step>

      <Step>
        Under **Manage**, select **Connectivity** and configure the following parameters:

        * **Tenant URL**—enter the SCIM endpoint URL provided by CData Support and append `?aadOptscim062020` to the end of the URL. This is Microsoft's recommended workaround for a known SCIM 2.0 issue.
        * **Secret Token**—enter the Bearer token provided by CData Support.

        Click **Test Connection**.
      </Step>

      <Step>
        Under **Manage**, select **Attribute Mapping**, then select the **Users** tab. In the row containing `mail` and `emails[type eq "work"].value`, click the Edit icon and configure the following:

        * Set **Match objects using this attribute** to **Yes**.
        * Set **Matching precedence** to **2**.

        Click **Apply** to save, then click **Save** on the Attribute Mapping page.

        <Note>If users in your organization do not have the `mail` attribute populated in Entra ID, edit the same row and change **Source attribute** to `userPrincipalName` to ensure the email field is always populated during provisioning.</Note>
      </Step>

      <Step>
        On the main Enterprise application page, select **Provision on demand**. Search for and select a user you assigned, then click **Provision**. Verify that the user appears in Connect AI.
      </Step>

      <Step>
        Under **Provisioning**, set **Provisioning Status** to **On** to begin provisioning all assigned users and groups.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        In the Okta Admin Console, navigate to **Applications** > **Browse App Catalog**. Search for **(OAuth Bearer Token) Governance with SCIM 2.0** and click **Add Integration**. Set an **Application label**, uncheck **Display application icon to users**, uncheck **Browser plugin auto-submit**, then click **Next** and **Done**.
      </Step>

      <Step>
        From the application settings page, click the **Provisioning** tab and click **Configure API Integration**. Select **Enable API Integration**. Enter the following values provided by CData Support:

        * **SCIM 2.0 Base URL**—the SCIM endpoint URL (remove any trailing slash)
        * **OAuth Bearer Token**—the Bearer token

        Optionally click **Test API Credentials** to verify the connection, then click **Save**.
      </Step>

      <Step>
        Next to **Provisioning to App**, click **Edit**. Enable the following features:

        * **Create Users**
        * **Update User Attributes**
        * **Deactivate Users**

        Uncheck **Set password when creating new users**, then click **Save**.
      </Step>

      <Step>
        Under **Attribute Mappings**, use the **X** button to delete the following rows, which can cause issues during updates:

        * **Primary email type**
        * **Primary phone type**
        * **Address type**
      </Step>

      <Step>
        Select the **Assignments** tab. Click **Assign** and select the users to provision to Connect AI.

        <Note>You must assign the same users to both the SCIM application and your SSO application in Okta.</Note>
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Direct API Provisioning, Updates, and Deprovisioning

In addition to IdP-based provisioning, you can manage users directly via the SCIM API. CData Support supplies a unique base URL following this format: `https://{your-domain.com}/scim/v2`. The URL endpoint contains the necessary user metadata. All SCIM endpoints require an `Authorization` header with a `Bearer` token.

To provision a new user, `POST` to your unique SCIM endpoint. The system provisions the user in Connect AI. There is no need for the user to verify via email. The new user has a default system role of Query user. See [Roles](/en/Roles) for details on system roles. The new user only has access to connections that have user-defined credentials turned on.

To update a SCIM user's name and email, use `PATCH` with the SCIM endpoint. When a SCIM update user request comes in, the system updates the information in Connect AI.

To delete a user, use `DELETE` and your unique SCIM endpoint. The SCIM delete event calls the delete endpoint. For complete deprovisioning, also call `DELETE /users/{id}` from the Management API to revoke PATs and any direct role and permission grants.

The Connect AI [Audit Log](/en/Logs#audit-log) displays SCIM user provisioning, updates, and deletions.

## Roles and Permissions

A user's access in Connect AI is the combination of group-derived roles (from SCIM group assignments), direct role assignments, and direct resource permissions. You can manage direct assignments and fully deprovision users using the Management API (base path `/api/v1/`):

| Method | Path | Description |
| - | - | - |
| `GET` | `/users` | List all users |
| `GET` | `/users/{id}` | Get a single user including their direct permissions |
| `PATCH` | `/users/{id}` | Update user attributes |
| `DELETE` | `/users/{id}` | Deprovision: revoke all PATs and remove all direct role and permission grants |
| `POST` | `/users/{id}/roles` | Assign a role directly to a user |
| `GET` | `/users/{id}/roles` | List all roles assigned to a user, showing whether each was assigned directly or inherited from a group |
| `DELETE` | `/users/{id}/roles/{role_id}` | Remove a direct role assignment |
| `POST` | `/users/{id}/permissions` | Assign a resource permission directly to a user |
| `GET` | `/users/{id}/permissions` | List direct permissions assigned to a user |
| `DELETE` | `/users/{id}/permissions/{permission_id}` | Remove a direct permission |

See [Roles](/en/Roles) for details on system and access roles.


# Virtual SQL Server Endpoint
Source: https://docs.cloud.cdata.com/en/SQL-Server

The Connect AI Virtual SQL Server allows you to establish a connection to your data from integration tools that support connections to SQL servers. The Virtual SQL Server mimics the behavior of a traditional SQL server, and it supports a range of query options.

## Authentication

Applications connect to the Virtual SQL Server through SQL Server Authentication using a Username and Password. When configuring the connection, set the properties as follows:

* The database server is **tds.cdata.com**.
* The port is **14333**. If you are connecting from application that does not have a separate port field, append the port to the end of the database server with either a colon or comma (`tds.cdata.com:14333` or `tds.cdata.com,14333`).
* Some applications require you to specify a database. For these applications, the database name is the name of the [Connection](/en/Sources) you want to access.
* For the Username, enter your Connect AI username. This is displayed in the top-right corner of the Connect AI interface. For example, *[test@cdata.com](mailto:test@cdata.com)*.
* For the Password, enter a Personal Access Token (PAT) that you generate on the [Settings](/en/Settings/Personal-Access-Tokens) page.

## Connect from Client Applications

Virtual SQL Server supports connections from the following integration tools:

* [Amazon QuickSight](/en/Clients/AmazonQuickSight-Client)
* [Azure Analysis Services](/en/Clients/AAS-Client)
* [Azure Data Factory](/en/Clients/AzureDataFactory-Client)
* [Looker](/en/Clients/Looker-Client)
* [Microsoft Power Apps](/en/Clients/MicrosoftPowerApps-Client)
* [Microsoft PowerAutomate](/en/Clients/MicrosoftPowerAutomate-Client)
* [Qlik Sense Cloud](/en/Clients/QlikSenseCloud-Client)
* [Tableau Cloud](/en/Clients/TableauCloud-Client)

After connecting to an integration tool, see [Query Syntax](/en/VSS-Query-Syntax) for examples of supported query syntax.


# Scheduled Queries
Source: https://docs.cloud.cdata.com/en/Scheduled-Queries

***Scheduled Queries*** jobs enable you to run saved queries on a given schedule.

With the Connect AI Scheduled Queries feature, you can save queries that you create in the Data Explorer as scheduled queries, or queries that run at regular intervals. You can use the [Query Builder](/en/QueryBuilder) to build the query or the SQL Editor to write a SQL query manually. You then save the query as a scheduled query. Next, you select the schedule for running the query. Finally, you select the target destination for saving the query. Connect AI supports the following destinations for Scheduled Queries:

* BigQuery
* Databricks
* PostgreSQL
* Redshift
* Smartsheet
* Snowflake

While you create scheduled queries in the Data Explorer, you manage them in the [**Jobs**](/en/Jobs) page.

The **Jobs** page contains a list of scheduled query jobs to run.

<Frame>
  <img alt="Scheduled queries jobs" />
</Frame>

For each job, the **Jobs** page displays the scheduled query name and target destination, the last time the job was run, the date and time of the next run, and the status of the job. You can select multiple jobs to run immediately by selecting the jobs and clicking **Run** at the top of the page. You can also delete multiple jobs by selecting them and clicking **Delete** at the top of the page.

The **Jobs** page also allows you to disable a particular scheduled query job, if you want to pause the scheduled job but not delete it. Use the toggle switch in the **Status** column to enable or disable a job. You cannot run a job manually as long as it is disabled.

## Configure Scheduled Queries

Before you can use the Schedule Queries feature, you need to add a destination connection, schema, and table for your scheduled query. The destination table contains the results of your scheduled query. If you haven’t already done so, add your destination connection in the **Add Connection** page. Note that the connection type for the destination must be one of the following: BigQuery, Databricks, PostgreSQL, Redshift, Smartsheet, or Snowflake. Go to [Sources](/en/Sources) for details.

## Add a Scheduled Query Job

You can add a schedule query job in one of two ways: on the Jobs page or in the Data Explorer.

### On the Jobs Page

<Steps>
  <Step>
    On the Jobs page, click **+Add Job** > **Scheduled Query**. This launches the Data Explorer.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    The Data Explorer opens a query containing the following message:

    ```bash theme={null}
    /*Execute a query and save it as a Scheduled Query to continue set up of your job.*/
    ```
  </Step>

  <Step>
    Now follow the instructions below for Data Explorer.
  </Step>
</Steps>

### In the Data Explorer

<Steps>
  <Step>
    In Data Explorer, use the Query Builder or SQL Editor to build your query. See [Query Builder](/en/QueryBuilder) for detailed steps.
  </Step>

  <Step>
    When you have finished creating and executing your query, click **Save** > **Save as Scheduled Query**.

    <Frame>
      <img alt="Scheduled queries save as" />
    </Frame>

    The **Add Job** page appears.
  </Step>

  <Step>
    In **Add Job**, enter the **Name** for your scheduled query.
  </Step>

  <Step>
    Set a schedule for your query in hours, days, weeks, or months. Then set a start date and time in UTC. The default date is today's date.
  </Step>

  <Step>
    Select whether to **Overwrite** or **Append** the current table in your destination connection. If the table exists, **Overwrite** deletes the current table and overwrites it with the new table. **Append** adds the latest query results to the current table.
  </Step>

  <Step>
    Select a **Destination Connection**. Note that only connections of the type mentioned above (BigQuery, Databricks, PostgreSQL, Redshift, Smartsheet, and Snowflake) are available as a destination connection.
  </Step>

  <Step>
    Select a **Destination Schema** if there is more than one schema. Otherwise, the default schema is used.
  </Step>

  <Step>
    Enter the **Destination Table** name for table to be created.

    <Frame>
      <img alt="Scheduled queries schedule" />
    </Frame>
  </Step>

  <Step>
    Click **Save Changes**. If the query is saved successfully, the **Status** of the scheduled query changes from **Draft** to **Queued**.
  </Step>

  <Step>
    You can edit the **SQL Code** in Data Explorer, if necessary.
  </Step>

  <Step>
    Click **Run Now** to run the scheduled query immediately.
  </Step>

  <Step>
    The scheduled query now appears in the Jobs queue.

    <Frame>
      <img alt="Scheduled queries jobs queue" />
    </Frame>
  </Step>
</Steps>

## Edit a Scheduled Queries Job

You can modify or delete a scheduled query job at any time by clicking the edit or delete icons in the jobs queue. You can also run a job manually at any time by clicking **Run Now**.

<Frame>
  <img alt="Scheduled queries edit job" />
</Frame>

In the **Edit Job** page, you can do the following:

* Change the query schedule, or change the destination write scheme.
* Change the destination connection and table.
* View the run history and status, making sure the previous job run was successful.
* Change the log verbosity.
* Run a single job manually. You can run multiple jobs in the main **Jobs** page.
* Disable the scheduled query temporarily by turning the toggle next to **Schedule Query** off.
* Edit the SQL code of the scheduled query.
* Delete the scheduled query.


# Settings
Source: https://docs.cloud.cdata.com/en/Settings-Embedded

You can access your *Settings* page by clicking the Gear Icon in the upper-right corner of the dashboard and selecting **Settings**.

<Frame>
  <img alt="" />
</Frame>

The Settings page is divided into four tabs:

* [**Profile**](#profile)
* [**Account**](#account)
* [**Sources**](#sources)
* [**Billing**](#billing)

<Frame>
  <img alt="" />
</Frame>

The following sections describe these tabs.

## Profile

The **Profile** tab opens by default when you access Settings. This tab contains settings for the account you are currently signed in with.

<Frame>
  <img alt="" />
</Frame>

In the **User Profile** section, you can edit the first name and last name for the current user. You cannot edit the **Role**.

You can change the email that you use to log in by entering the new email and clicking **Save Changes**. If you want to reset your password, click **Reset Password**. This action sends a password reset email to the email address that appears in **Email**.

## Account

The **Account** tab provides access to account-wide settings and troubleshooting features.

<Frame>
  <img alt="" />
</Frame>

The sections of this page are described below.

### General

The **General** section lists the following global account information:

* Organization Name
* Account Id
* Country

Copy the Account Id to use in the API.

Toggle **Display Connection Data Model** to show the data model on the Add and Edit Connection page for authenticated connections.

### Primary Contact Information

This section contains the following fields that define the account’s primary contact for invoices, announcements, and other communication:

* First name
* Last name
* Email
* Phone Number
* Country

### Delete Account

If you want to delete your Connect AI Embed account and all of its data, click **Contact Sales** for assistance.

<Note>
  Account deletion is permanent. If you delete your account, you need to create a new account if you want to use Connect AI Embed in the future.
</Note>

## Sources

By default, when your customers' end users authenticate to an OAuth data source (such as Salesforce or Google), they see CData's application name in the OAuth consent screen. **Connection Overrides** allow you to register your own OAuth application with each data source provider so that end users see your application name and branding instead.

This keeps the authentication experience consistent with your product and removes CData's name from your customers' view.

The **Sources** tab allows the administrator of the Connect AI Embed parent account to manage connection string properties for the sub-accounts, ensuring consistent configurations across sub-accounts and OAuth sign-in with your brand name.

<Frame>
  <img alt="" />
</Frame>

This tab consists of the following:

* The **Source Access Control** section allows administrators to choose which data sources your accounts can use when creating new connections. Administrators can limit end users to specific sources.

  <Note>The **Source Access Control** section is only relevant if your sub-accounts are using the **Add Connection** page that displays all the sources.</Note>

* The **Connection Overrides** section allows administrators to add custom overrides to simplify account setup. For example, you can override an account's OAuth sign-in credentials so that end users must use their own organization's credentials rather than CData credentials. Click **Add Override** and then select the setting and the override value.

  **Connection Overrides** contains the following information about each override:

  * **Source**—the data source name.
  * **Setting**—the connection setting to override.
  * **Override**—the new value of the setting to use.
  * **Job Actions**—the icons in the last column represent the actions you can perform on a job.
    * **Edit (🖉)**—edit the override value. Note that you can only edit the value of the override, and you cannot edit the setting to be overridden.
    * **Delete (🗙)**—delete the connection override for future connections. Note that existing connections remain unchanged.

  <Note>Not all data sources have available setting overrides.</Note>

To add a connection override:

<Steps>
  <Step>
    Click **+Add Override**.
  </Step>

  <Step>
    Search for the data source you want to configure the override for.
  </Step>

  <Step>
    Select the override setting and the override value.
  </Step>

  <Step>
    Select whether the override should be applied to new connections only (the **Add Connection** page), or to all new and existing connections (the **Add Connection** and **Edit Connection** pages).
    <Note>If you apply the override to all new and existing connections, you may be required to reauthenticate existing connections.</Note>
  </Step>

  <Step>
    Click **Confirm**. The new connection override appears in the **Connection Overrides** section.
  </Step>
</Steps>

## Billing

The **Billing** tab provides information and controls for your account plan and usage.

<Frame>
  <img alt="" />
</Frame>

This tab consists of the following:

* The **Billing** section displays your plan information and next billing date.
* The **Your Plan Includes** section displays what is included in your current plan.
* The lower pane displays your remaining usage in the plan.


# Sources
Source: https://docs.cloud.cdata.com/en/Sources-Embedded

The ***Sources*** page displays a read-only list of sources your sub-accounts are connected to.

<Frame>
  <img alt="Sources" />
</Frame>

The **Sources** page contains the following information about each connection:

* **Connection Name** and **Data Source**—the user-defined name of the connection and the data source type of the connection. This column also contains an icon indicating that the data source supports custom reports.
* **Account**—the sub-account using the connection.
* **Last Queried**—the last time an end user queried the data.
* **Status**—The status of the connection, which can be one of the following:
  * **Authenticated**—the connection to the data source is successful.
  * **Not Authenticated**—the connection was created in Connect AI, but is not successfully connected to the data source. You can return to the connection's edit screen to authenticate the connection. Note that Query users need to contact an administrator to authenticate a connection.
  * **Conditional**—the connection is conditional based on the global settings and tables added to the connector. This occurs with the API connector.
* **Last Modified**—the date and time an end user last modified the connection. Click the user icon next to the date and time to display the user who last modified the data.


# Users
Source: https://docs.cloud.cdata.com/en/Users-Embedded

The ***Users*** page enables you to manage the users on your Connect AI Embed account.

## About Users

A ***user*** is an account that can log in and administer Connect AI Embed, such as viewing and managing accounts. Two types of Connect AI Embed users are available:

* **Administrators** have full access to all Connect AI Embed functions, including adding, deleting, and managing users and accounts.
* **Viewers** have read-only privileges across Connect AI Embed.

Every Connect AI Embed account must have at least one active administrator.

## Users List

The **Users** list displays the following information:

* A button to [invite users](#invite-users).
* A row for every user on your Connect AI Embed account:
  * **User** displays the email address that is associated with the user.
  * **Role** indicates the user’s role (Administrator or Viewer).
  * **Status** shows the state of the user’s account (**Active**, **Inactive**, or **Invited**).
  * Buttons to edit and delete the user. If the user's status is **Invited**, there is also a button to resend their invitation.
  <Frame>
    <img alt="Users list" />
  </Frame>

## Invite Users

To add users to your Connect AI Embed account, follow these steps:

<Steps>
  <Step>
    Click **Invite Users** to open the user invitation dialog.
  </Step>

  <Step>
    Enter the email address of the user that you want to invite. To send multiple invitations at the same time, add a space between each email address.

    <Frame>
      <img alt="Invite users" />
    </Frame>
  </Step>

  <Step>
    Click **Send Invite**. If a user is registered already to an email address that you enter, the dialog prompts you to enter a different email address.
  </Step>
</Steps>

### Accepting an Invitation

Follow these steps to set up access after receiving an invitation email:

<Steps>
  <Step>
    Click **Accept Invite** in the invitation email to open the password creation page.
  </Step>

  <Step>
    Create a password that meets the provided criteria. After you create a password, the login page appears.
  </Step>

  <Step>
    Log in with your email address and your new password. After you log in, the sign-up page appears.
  </Step>

  <Step>
    Enter your first name and the contact last name.
  </Step>

  <Step>
    Enter the account name and the invite code from the invitation email. Then, click **Complete Sign Up**.

    <Frame>
      <img alt="User signup" />
    </Frame>
  </Step>
</Steps>

<Note>
  Connect AI Embed supports Single Sign-On (SSO) through popular SSO providers. If SSO is enabled on your account, the invitation flow uses your SSO provider instead of the manual password process.
</Note>

### Managing Invitations

If a user has a pending invitation that they have not accepted, their status displays as **Invited**. Click the resend button to send another invitation email, or click the delete button to delete the user.

## Edit User

Click a user in the list to open the **Edit User** page.

<Frame>
  <img alt="Edit user" />
</Frame>

This page contains the following information:

* Editable **First Name** and **Last Name** fields.
* A non-editable **Email** field.
* A drop-down menu to select the user’s **Role** (**Administrator** or **Viewer**).

To save changes to the user, click **Save Changes**. To delete the user, click **Delete User**.

<Note>
  If the user is the last remaining Administrator on your account, they cannot be deleted.
</Note>


# Query Syntax
Source: https://docs.cloud.cdata.com/en/VSS-Query-Syntax

You can execute SQL queries against your Virtual SQL Server just as you would query a traditional SQL Server database. You can also execute stored procedures.

## Select Statements

The following syntax diagram outlines the supported **SELECT** syntax:

```bash expandable theme={null}
SELECT {
  [ TOP <numeric_literal> | DISTINCT ]
  {
    *
    | {
      <expression> [ [ AS ] <column_reference> ]
      | { <table_name> | <correlation_name> } .*
  } [ , ... ]
  }
  [ INTO csv:// [ filename= ] <file_path> [ ;delimiter=tab ] ]
  {
    FROM <table_reference> [ [ AS ] <identifier> ]
  } [ , ... ]
  [ [
      INNER | { { LEFT | RIGHT | FULL } [ OUTER ] }
    ] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ]
  ] [ ... ]
  [ WHERE <search_condition> ]
  [ GROUP BY <column_reference> [ , ... ]
  [ HAVING <search_condition> ]
  [ UNION [ ALL ] <select_statement> ]
  [
    ORDER BY
    <column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
  ]
  [
    LIMIT <expression>
  [
    { OFFSET | , }
    <expression>
  ]
  ]
} | SCOPE_IDENTITY()
 
<expression> ::=
  | <column_reference>
  | @ <parameter>
  | ?
  | COUNT( * | { [ DISTINCT ] <expression> } )k
  | { AVG | MAX | MIN | SUM | COUNT } ( <expression> )
  | NULLIF ( <expression> , <expression> )
  | COALESCE ( <expression> , ... )
  | CASE <expression>
      WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
    [ ELSE { <expression> | NULL } ]
    END
  | <literal>
  | <sql_function>
 
<search_condition> ::=
  {
  <expression> { = | > | < | >= | <= | <> | != | 
                 LIKE | NOT_LIKE | IN | NOT_IN | IS_NULL | IS_NOT_NULL | 
                 AND | OR | CONTAINS | BETWEEN 
               } [ <expression> ]
  } [ { AND | OR } ... ]
```

## Insert Statements

The **INSERT** statement specifies the columns to be inserted and the new column values. You can specify the column values in a comma-separated list in the **VALUES** clause:

```bash theme={null}
INSERT INTO <table_name>
  ( <column_reference> [ , ... ] )
VALUES
  ( { <expression> | NULL } [ , ... ] )
 
<expression> ::=
  | @ <parameter>
  | ?
  | <literal>
```

## Update Statements

To issue an **UPDATE** query, provide a comma-separated list of columns and new column values as name-value pairs in the **SET** clause, as shown below:

```bash theme={null}
UPDATE 
  <table_name> 
SET 
  { <column_reference> = <expression> } [ , ... ] 
WHERE 
  Id = <expression>  } [ { AND | OR } ... ]
 
<expression> ::=
  | @ <parameter>
  | ?
  | <literal>
```

## Delete Statements

The **DELETE** statement requires:

* The table name in the **FROM** clause
* The primary key for the row in the **WHERE** clause

This format is shown below:

```bash theme={null}
DELETE FROM <table_name> 
WHERE { 
  Id = <expression> 
} [ { AND | OR } ... ]
 
<expression> ::=
  | @ <parameter>
  | ?
  | <literal>
```

## Stored Procedures

Stored procedures from Virtual SQL Server can be executed as follows:

```bash theme={null}
-- WITHOUT parameters
EXECUTE [ConnectionName].[SchemaName].[ProcedureName]

-- WITH Parameters
EXECUTE [ConnectionName].[SchemaName].[ProcedureName] @ParameterName1 = <value1>, @ParameterName2 = <value2>, ...
```


# Virtual Databases
Source: https://docs.cloud.cdata.com/en/Virtual-Databases



## Overview

**Virtual Databases** provide a new way to access, model, govern, and deliver data. A virtual database mimics a real database. Applications can connect like they normally would to a database, but the connection is actually a live data connection to the data source. Virtual databases use well-known SQL constructs through a virtual relational layer, allowing you to perform any query involving several data sources.

## Virtual SQL Server

CData’s [Virtual SQL Server](/en/SQL-Server) implements the Tabular Data Stream (TDS) protocol. It emulates a standard SQL server and allows you to query your data like any other SQL source. Virtual SQL server endpoints are available by using workspaces in Connect AI. The default Virtual SQL server allows access to all tables, but you can connect to a workspace if you want to restrict access to a specific number of data assets.


# Getting Started
Source: https://docs.cloud.cdata.com/en/docs-Embedded

*Connect AI Embed* allows you to add AI-powered data access to your own product, without building the data connectivity infrastructure yourself. Your end users can interact with their data in natural language, through AI agents that you control and configure. CData handles the connection to hundreds of data sources, and you handle the experience your customers see.

This guide walks you through the steps to get your first sub-account set up, create a data source connection, and start querying data using AI. Before you start, it helps to understand a few key terms used throughout the guide.

## Key Features

* **Broad Data Connectivity:** Connect AI Embed allows you to transform data into a standard language that any reporting tool, analytics dashboard, or spreadsheet can understand. It can connect to a vast range of applications (including those for accounting, marketing, customer relationship management, and more) by using a consistent approach that is already supported by many data tools.
* **Live Data Access:** Connect AI Embed gives you live access to your data—queries run directly against the source system at the moment they are made, without moving data to a separate location first. This approach avoids the pitfalls of traditional Extract, Transform, Load (ETL) processes that rely on moving data to separate locations.
* **Read and Write Support:** Connect AI Embed supports both read and write operations across hundreds of integrated data sources, allowing AI agents and embedded applications to query, create, update, and delete records. Operations are controlled by security settings that you can configure in Connect AI Embed or in your data sources.
* **Secure Access:** Administrators can create query users and define their access permissions for each data source individually.
* **Comprehensive Data Model & Dynamic Discovery:** Connect AI Embed provides comprehensive access to all of the data that is exposed in the underlying connections, including full access to dynamic data and searchable metadata.

For more information about these key features, see [Technology](/en/Technology-Embedded).

## Key Terms

* **Parent Account**—Your top-level CData account. As the Independent Software Vendor (ISV), this is the account you use to manage your entire Connect AI Embed deployment, including creating and overseeing all sub-accounts.
* **Sub-Account**—An account that sits beneath your parent account, representing one of your customers or tenants. Sub-accounts are where connections are created and data is queried. Each sub-account is isolated from the others.
* **ISV/Embedded Customer**—These terms all refer to the same entity: your company, which is building a product on top of Connect AI Embed. You control the experience your end users see.
* **End User**—An individual user within one of your customers' sub-accounts. End users interact with your application. They do not interact directly with Connect AI Embed except during initial data source setup.
* **Connection**—A configured link to a data source (for example, Salesforce, Jira, or ServiceNow). Connections belong to a sub-account and can be shared across all end users in that sub-account, or set up individually per end user.
* **MCP (Model Context Protocol)**—An open standard that allows AI agents to connect to and query data sources. Connect AI Embed exposes MCP servers that your AI agents use to access connected data. The standard endpoint provides access across all connected sources. Connect AI Embed administrators can also scope MCP access to specific connections, limiting the end users' data access. See [MCP](/en/API/MCP-Embedded) in the API Reference for details.
* **JWT (JSON Web Token)**—A secure, signed token used to authenticate all API requests to Connect AI Embed. Every JWT must identify the parent account (`iss`). Most calls also require the sub-account ID (`sub`). For scoped MCP server access, the JWT must additionally include a `connection_ids` claim specifying which connections the end user can access. See [Authentication](/en/API/Authentication-Embedded) for details.

## Get Started

For a high-level overview about setting up and using Connect AI Embed, see [Quick Start Guide](/en/Quick-Start-Embedded).

For more detailed information about the features of Connect AI Embed, see the documentation outlined below:

* [Navigation](/en/Navigation-Embedded)—Information about navigating Connect AI Embed and accessing features.
* [Dashboard](/en/Dashboard-Embedded)—An overview of recent queries and account activity for a selected sub-account, as well as a summary of all sub-accounts.
* [Accounts](/en/Accounts-Embedded)—An overview of the names, account Ids, and number of connections of each connected sub-account.
* [Connection API](/en/API/Connection-API)—The API to connect data sources to Connect AI Embed.
* [SQL Reference](/en/SQL-Reference/SQL-Reference)—List of supported SQL syntax and code examples.
* [Reference Architecture](/en/Architecture-Embedded)—Diagram of the three zones: your infrastructure, the Connect AI Embed managed service, and your customers' data sources.
* [Private Cloud Connector](/en/Private-Cloud-Connector-Embedded)—Live, read-write access to on-premises data sources without moving data outside a firewall.
* [Build Your First Agent](/en/Build-Agent-Embedded)—A developer-oriented guide: create a sub-account, connect a source, and start querying live data through MCP.

## Get Support

For assistance with using *Connect AI Embed*, there are two main resources available:

* The [Status page](https://status.cdata.com/), which shows the current status and incident history for the application services.
* [CData Technical Support](https://www.cdata.com/support/submit.aspx), which you can also access by clicking the **Support** link at the bottom of the dashboard.


# CData Cloud Services Agreement
Source: https://docs.cloud.cdata.com/en/terms-of-service



#### CData Cloud Services Agreement

This Cloud Services Agreement (the “Agreement”) is made between CData Software, Inc., a Delaware corporation (“CData”) and the party (“Customer”) that subscribes for the Cloud Services, as defined in the Order Form. Between CData and each Customer the Agreement consists of these terms, each signed order form or online enrollment (including any notes, pricing or other terms listed therein) (the “Order Form”), including any exhibits, and any updates or amendments to each. This Agreement is effective as of the date of Customer’s initial Order Form (the “Effective Date”). By executing the initial Order Form or accessing the Cloud Services, Customer agrees to all the terms set forth below. In the event of a conflict between the Order Form and this Agreement, this Agreement shall control unless the applicable provisions of the Order Form expressly states that it will control.

#### 1. CLOUD SERVICES; SUPPORT

**1.1 Cloud Services.** CData grants Customer a limited, non-exclusive, non-sublicensable, non-transferable (except as specifically permitted in this Agreement) right to access and use the Cloud Services during the applicable Subscription Term, and in scope of use restrictions as set forth in the applicable Order Form, solely for Customer’s internal business purposes. “Cloud Services” means the web-based product developed, provided, and hosted by CData as specified on an Order Form. As part of the registration process, Customer will identify an administrative username(s) and password(s) for Customer’s paid user(s) of the Cloud Services (each an “Authorized User”).

**1.2 Login; Orders by Affiliates.** Only one Authorized User may use the same login credentials. In accessing the Cloud Services as permitted under the Agreement, Customer must report any security breaches promptly to CData. Customer shall keep such login credentials updated and secure and Customer is responsible for any breaches of security that occur through Customer’s access or login credentials of the Cloud Services. Customers and Affiliates may each use the Cloud Service pursuant to this Agreement. To the extent Customer’s Affiliates wish to make separate purchases, any of Customer’s Affiliates may execute a new Order Form for Cloud Services purchased specifically for that Affiliate entity and will be subject to this Agreement unless otherwise noted. “Affiliate” means an entity controlling, controlled by or under common control with a party to this Agreement at any time during the term of this Agreement, for so long as such ownership and control exists, provided such entity is not a current or prospective competitor to CData or in the business of developing and offering products or technologies that are substantially similar to the Cloud Services.

**1.3 Support.** CData will provide technical support in accordance with the <a href="https://www.cdata.com/support/">CData support policy</a>. Support is subject to the terms of this Agreement, the Order Form, and the CData support policy. Customer acknowledges and agrees that employees or contractors of CData or its Affiliates may test and monitor Customer’s connections and integrations for the purpose of testing, troubleshooting, and improving the Customer’s usage of the Cloud Services. CData will not access Customer’s account or Customer Data without permission from Customer. In the event Customer grants the CData team permission to access Customer’s account or Customer Data, employees or contractors of CData or its Affiliates will access Customer’s account and may query the data accessed by Customer during Customer’s usage of the Cloud Services, change the Customer’s settings, and otherwise modify Customer’s account for the sole purpose of troubleshooting and improving the Customer’s usage of the Cloud Services.

**1.4 Evaluation and Development Terms; Pre-Production Software.** Where CData licenses the Cloud Services to Customer on a development, evaluation, or trial basis, or where the license type for the Cloud Services is designated as Early Adopter, Early Access, Alpha, Beta, or similar (“Pre-Production Software”), the following terms apply. CData grants Customer a temporary, non-exclusive, non-transferable license, without a right to sublicense, to use the Cloud Services solely for internal development, non-production evaluation and trial purposes, subject to all the restrictions detailed in this Agreement, until the earlier of: (a) the end of the evaluation period, if any, specified in the Quote, or otherwise communicated by CData at the time of delivery; (b) the start date of a paid for license to the Cloud Services; or (c) termination in accordance with the terms of this Agreement. Customer may not extend the authorized license period by uninstalling and re-installing the Cloud Services, modification of login identities or credentials, or by any other means other than CData’s written consent. If Customer chooses not to continue to license the Cloud Services after the authorized license period, Customer shall delete and destroy the Cloud Services and all copies thereof in Customer’s possession or control, including all login authorization information, as applicable. Cloud Services licensed to Customer on a development, evaluation, pre-production, or trial basis may be subject to one or more usage limits specified herein or otherwise communicated at the time of delivery (including posting of such limits at the location where Customer accesses the Cloud Services for development or evaluation). CData may, in its sole discretion, decide whether to offer any maintenance and support for the Cloud Services during the designated license period, and to include any additional conditions or limits on such maintenance and support. As applicable, Customer hereby grants CData a limited, non-exclusive, and non-transferable right to host and use Customer Data solely to the extent necessary to provide the development, evaluation, or pre-production Cloud Services to Customer for the limited purposes detailed herein. The licenses described in this section are provided as is and at Customer’s own risk and are not covered by any of the CData warranties, representations, or other protections detailed herein. Customer may not circumvent any technical limitations included in the Cloud Services licensed to Customer on a development, evaluation, trial, or pre-production basis. Customer acknowledges and agrees that the Pre-Production Software versions are not final releases and may contain bugs, performance issues, or other problems, which CData has no responsibility to remedy. Your use of the Pre-Production Software is at your own risk, and we will not issue credits or other compensation related to the Pre-Production Software. You agree not to use any Pre-Production Software for production, mission-critical, or commercial purposes.

#### 2. RESTRICTIONS AND RESPONSIBILITIES

**2.1 Use of Software Underlying Cloud Services.** Customer will not, directly or indirectly: reverse engineer, decompile, disassemble or otherwise attempt to discover the source code, object code or underlying structure, ideas, know-how or algorithms relevant to the Cloud Services or any software, documentation or data related to the Cloud Services (the “Software”); modify, translate, or create derivative works based on the Cloud Services or any Software (except to the extent expressly permitted by CData in writing or authorized within the Cloud Services); frame, mirror or use the Cloud Services or any Software for timesharing or service bureau purposes or otherwise for the benefit of a third party; or remove any proprietary notices or labels.

**2.2 Use of Cloud Services.**

**(A) Usage Restrictions.** Customer will not and shall ensure that Authorized Users do not, directly or indirectly: (i) reverse engineer, decompile, disassemble or otherwise attempt to discover the source code, object code or underlying structure, ideas, know-how or algorithms relevant to the Cloud Services, any software related to the Cloud Services, or the Documentation (collectively, the “CData Materials”); (ii) permit any third party to access the CData Materials except as permitted herein and in the relevant Order Form, (iii) modify, translate, publish, or create derivative works based on the CData Materials (except to the extent expressly permitted by CData in writing or authorized within the Cloud Services), (iv) copy, frame or mirror any part or content of the CData Materials, including for service bureau or time sharing purposes or otherwise make the CData Materials available to a third party, (v) decompile, disassemble, translate, reverse engineer or otherwise attempt to derive source code from the CData Materials, in whole or in part, nor will Customer use any mechanical, electronic or other method to trace, decompile, disassemble, or identify the source code of the CData Materials or encourage or permit others to do so (except and only to the extent that applicable law prohibits or restricts reverse engineering restrictions), (vi) access the CData Materials in order to (a) build a competitive product or service, or (b) copy any features, functions or graphics of the CData Materials, (vii) sell, resell, rent or lease the CData Materials, (viii) use the CData Materials to store or transmit infringing, libelous, or otherwise unlawful or tortious material, or to store or transmit material in violation of third-party intellectual property rights, privacy rights, or rights of publicity, or otherwise use the CData Materials in violation of the Documentation or this Agreement, (ix) remove any proprietary notices or labels, (x) store or transmit viruses or other malicious code through the CData Materials, (xi) interfere with or disrupt the integrity or performance of the CData Materials, or third-party products or data contained therein, or (xii) attempt to gain unauthorized access to the CData Materials or their related systems or networks. Where the license CData grants to Customer is subject to usage requirements, Customer agrees to comply with the CData Fair Usage Policy, located at [https://www.cdata.com/ai/fair-use/](https://www.cdata.com/ai/fair-use/). Customer acknowledges that Customer is solely responsible for complying with, and covenants to comply with, all laws applicable to Customer and to Customer’s use of the CData Materials, including without limitation all laws and regulations relating to the protection and non-disclosure of Customer Data (as defined in Section 3.1). Without limiting the generality of the foregoing, the Customer is solely responsible for using the Cloud Services in compliance with any applicable laws regarding data privacy or personally identifiable information.

**(B) Excess Use.** Where Customer licenses the Cloud Services from CData under a usage-based pricing model, in the event Customer exceeds the usage limits detailed in the applicable Order Form, or the usage limits otherwise provided by CData, CData will notify Customer of such overages, and Customer shall pay the applicable fees to upgrade to the next applicable pricing and usage tier.

**2.3 Protection of Customer Data.** CData will maintain administrative, physical, and technical safeguards for protection of the security, confidentiality, and integrity of Customer Data in accordance with the CData Information Security Policy, which is available upon request. CData may update this policy provided any such updates will not degrade or materially change CData’s obligations therein. Those safeguards will include, but will not be limited to, measures for preventing access, use, modification or disclosure of Customer Data by CData personnel except: (a) to provide the Cloud Services and to prevent or address service or technical problems; or (b) as Customer expressly permits in writing. In cases in which Data Protection Laws apply to the provision of Products to Customer, the parties will comply with the data processing addendum terms located at [https://www.cdata.com/company/legal/dpa/](https://www.cdata.com/company/legal/dpa/). For the purposes of the foregoing, “Data Protection Laws” has the meaning attributed to this term at the foregoing URL. For the Cloud Services, CData does not directly monitor, track, or inspect Customer Data, including personally identifiable information (PII), and, except as expressly authorized by CData, does not accept or monitor for protected healthcare information (PHI). Customer may configure the appropriate software settings based on Customer’s use and security standards. CData will not: (a) modify Customer Data, (b) disclose Customer Data except as compelled by law or as expressly permitted in writing by Customer, or (c) access Customer Data, except to access to address service or technical problems as detailed in Section 1.3. Any exchange of data between Customer and any third party, is solely between Customer and the applicable third party. CData may collect usage telemetry, reporting, and other statistics from the Product, which usage data does not contain PII or identifiable Customer Data, for the purpose of monitoring compliance with applicable usage limits, and for diagnostic, operational, performance, analytics, and product improvement purposes.

**2.4 Third-Party Services; OpenAI Services.** Where Customer uses the Cloud Services in conjunction with a third-party product or third-party data source (“Third-Party Service”), Customer is responsible for configuring such accounts in accordance with Customer’s internal standards, maintaining in good standing all required accounts with the applicable Third-Party Service and agreeing to, and complying with, all applicable requirements of the Third-Party Service. CData does not control and is not responsible for the terms of service, acceptable use policies, or other requirements imposed by any Third-Party Service. Customer is solely responsible for ensuring that its use of the Cloud Services complies with all applicable terms of such Third-Party Services. CData shall have no liability for any account action, service disruption, or other consequence imposed by a Third-Party Service in connection with Customer’s use of the Cloud Services. Customer understands and agrees that CData may be required to modify or remove functionality within the Cloud Services related to a Third-Party Service if: (a) a Third-Party Service requests that CData do so, or (b) CData is required to do so by law, government order, or other legal process. If CData exercises its rights under Section 2.4(a)-(b), CData will provide Customer with notice and information regarding such actions as soon as practicable under the circumstances, and Customer shall promptly take any required actions in response to CData’s notice. If Customer chooses to access the OpenAI-connected features of the Cloud Services, Customer understands and agrees that the Cloud Services will send metadata as well as Customer data related to Customer’s use of such features to Azure OpenAI. This means that any sensitive information (including personal information as that term is defined under various privacy laws) contained in Customer questions or other Customer data could be passed to Azure OpenAI. CData will not train models using such data, and CData’s third-party partner (Azure OpenAI) has made representations that they will not train models using such data.

**2.5 HIPAA Data Warning.** Except as expressly authorized by CData, Customer understands and agrees that it shall not use the Cloud Services to process any sensitive information, including any patient information (e.g., patient names, telephone numbers, any dates associated with a patient, and any unique identifying numbers associated with patient accounts) or any information that is subject to restrictions imposed by the Health Insurance Portability and Accountability Act of 1996 (HIPAA) (as amended). It is Customer’s responsibility to ensure that such information is not used with or disclosed to the Cloud Services.

#### 3. CONFIDENTIALITY

**3.1 Confidential Information.** Subject to the limitations set forth herein, all information disclosed by one party to the other party during the term of this Agreement, whether in oral, written, graphic or electronic form, shall be deemed to be “Confidential Information”. Confidential Information of CData includes non-public information regarding features, functionality and performance of the Cloud Services and Software. Confidential Information of Customer includes Customer Data.

**3.2 Exceptions.** Confidential Information does not include information which: (a) is part of the public domain at the time of disclosure; (b) becomes a part of the public domain through no fault of the receiving party or persons or entities to whom the receiving party has disclosed, transferred or permitted access to such information; (c) becomes available to the receiving party on a non-confidential basis from a source legally entitled to share the information without confidential treatment; (d) is independently developed by the receiving party without use of or access to the disclosing party’s Confidential Information; or (e) is released from the confidentiality obligations herein by written consent of the disclosing party.

**3.3 Nondisclosure.** Each party covenants that it will not disclose any Confidential Information of the other party to any person or entity except: (a) to agents of the receiving party who have a need to know such information, who are subject to confidentiality agreements with the receiving party at least as protective of the disclosing party’s Confidential Information as this Agreement, or (b) pursuant to the terms of a valid and effective subpoena or court order, provided that the receiving party immediately notifies the disclosing party (to the extent permitted) of the existence, terms and circumstances surrounding such a request so that the disclosing party may seek appropriate protective action. Neither party may use the other party’s Confidential Information in any directly competitive manner or for any purpose other than to exercise its rights and comply with its obligations under this Agreement.

**3.4 Return; Destroy; Protect.** On the disclosing party’s request, the receiving party must return or destroy all Confidential Information of the disclosing party which has been supplied to or acquired by the receiving party other than: (a) records the receiving party has a separate legal right or obligation to retain; and (b) copies of Confidential Information created in the ordinary course of the receiving party’s business and retained in accordance with its internal document retention and information technology policies. To the extent the receiving party retains information disclosed by the disclosing party, the receiving party will continue to protect such information in accordance with Section 3.3: (x) for so long as it meets the definition of Confidential Information above; (y) if it constitutes a trade secret for so long as required under applicable law, and/or (z) if it constitutes personal data received from the disclosing party for so long as required by applicable law.

**3.5 Customer Identification.** CData may identify Customer as a user of the Cloud Services and may use Customer’s name and logo in CData’s customer list, press releases, blog posts, advertisements, and website.

#### 4. PROPRIETARY RIGHTS

**4.1 Ownership Rights.** Customer owns all right, title and interest in and to all information, data, and other materials that Customer provides, uploads to, or otherwise stores via the Cloud Services, or that Customer directs CData to collect on Customer’s behalf, and all intellectual property rights related to any of the foregoing, excluding the Cloud Services and Software (“Customer Data”). CData owns and retains all right, title and interest in and to (a) the Cloud Services and Software, all improvements, enhancements or modifications thereto, (b) any software, applications, inventions or other technology developed by or on behalf of CData in connection with the Cloud Services, and (c) all intellectual property rights related to any of the foregoing.

**4.2 Injunction for Breach.** The parties agree that damages would be an inadequate remedy in the event of a breach of Sections 3 or 4. Therefore, the parties agree that a party is entitled, in addition to any other rights and remedies otherwise available, to seek injunctive and other equitable relief in the event of a breach or threatened breach by the other party of Sections 3 or 4.

#### 5. PAYMENT OF FEES

**5.1 Calculation of Fees.** Customer will pay CData the applicable fees described in each Order Form (the “Fees”). Fees for committed prepaid subscriptions are identified on the initial Order Form. Except as otherwise provided herein or as set forth by our payment processor here [https://stripe.com](https://stripe.com), all fees are nonrefundable. Per-Authorized User pricing assumes normal query usage per paying Authorized User of the Services. If Customer’s use of the Cloud Services exceeds the capacity set forth herein or on the Order Form(s), or otherwise requires the payment of additional fees, CData will invoice Customer in arrears for such additional usage and Customer agrees to pay the additional Fees in the manner provided herein.

**5.2 Payment Terms.** CData will bill for the Cloud Services through an invoice, through the marketplace where the original purchase was made, or directly through credit card if provided. Full payment for invoices issued in any given month must be received by CData within 30 days after the issuance of the invoice (which may be sent by email). If Customer is paying by credit card, Customer represents and warrants that it has the right to use the credit card provided and grants CData the right to provide the credit card information, including the credit card number, its expiration date and billing address, to third parties for the purposes of facilitating payment transactions. Verification of information may be required prior to the acknowledgment or completion of any payment transaction. Unpaid amounts are subject to a finance charge of 1.5% per month on any outstanding balance, or the maximum permitted by law, whichever is lower, plus all expenses of collection and may result in immediate termination of Cloud Services. Customer is responsible for any sales, use, value added, excise, property, withholding or similar tax and any related tariffs, and similar charges, except taxes based on CData’s net income. If Customer is required to pay any such taxes, Customer shall pay such taxes with no reduction or offset in the amounts payable to CData hereunder. If an applicable tax authority requires CData to pay any taxes that should have been payable by Customer, CData will advise Customer in writing, and Customer will promptly reimburse CData for the amounts paid. If Customer believes that CData has billed Customer incorrectly, Customer must contact CData no later than 60 days after the date of the first billing statement in which the error or problem appeared, in order to receive an adjustment or credit. Inquiries should be directed to CData’s accounting department. Without limiting its other remedies, CData may suspend Cloud Services for nonpayment of fees.

#### 6. TERM AND TERMINATION

**6.1 Term.** This Agreement will continue from the Effective Date until the earlier of: (a) the expiration of all Cloud Services subscriptions or (b) termination pursuant to Section 6.2 below (together, the “Term”). Month-to-month plans will renew automatically each month and may be cancelled at any time on notice by either party to the other. Each Cloud Services subscription will run for the subscription term specified in the applicable Order Form and will renew automatically on CData’s then-current terms and conditions for one-year periods unless a party provides notice of nonrenewal to the other party at least 30 days prior to expiration of the applicable subscription term. CData will notify Customer in connection with any renewal to provide opportunity for notice and/or cancellation.

**6.2 Termination for Cause.** In addition to any other remedies it may have, (A) either party may terminate this Agreement upon written notice (or without notice in the case of nonpayment), if the other party (i) materially breaches any of the terms or conditions of this Agreement and fails to cure such breach within 30 days after written notice describing the breach; or (ii) files for bankruptcy or is the subject of an involuntary filing in bankruptcy (in the latter case, which filing is not discharged within 60 days) or makes an assignment for the benefit of creditors or a trustee is appointed over all or a substantial portion of its assets and (B) CData may additionally terminate this Agreement and the Cloud Services (or any portion of the Cloud Services) immediately and without notice if it has reason to believe Customer is violating Section 2 of this Agreement. In the case where CData terminates this Agreement for Customer’s breach, Customer remains obligated to pay the balance due on Customer’s account for the remainder of the Term, computed in accordance with the applicable Order Form(s), and will be billed for such unpaid fees.

**6.3 Survival.** All sections of this Agreement which by their nature should survive termination will survive termination, including, without limitation, accrued rights to payment, confidentiality obligations, warranty disclaimers, and limitations of liability.

#### 7. WARRANTIES AND DISCLAIMER

**7.1 Authority.** Each of CData and Customer represents and warrants that: (a) it has the full right, power and authority to enter into and fully perform this Agreement; (b) the person signing this Agreement on its behalf is a duly authorized representative of such party who has in fact been authorized to execute this Agreement; (c) its entry herein does not violate any other agreement by which it is bound; and (d) it is a legal entity in good standing in the jurisdiction of its formation.

**7.2 Cloud Services Warranty.** CData shall use reasonable efforts consistent with prevailing industry standards to maintain the Cloud Services in a manner which minimizes errors and interruptions in the Cloud Services and shall perform implementation and support Cloud Services in a professional and workmanlike manner.

**7.3** CDATA DOES NOT WARRANT THAT THE CLOUD SERVICES WILL BE UNINTERRUPTED OR ERROR FREE; NOR DOES IT MAKE ANY WARRANTY AS TO THE RESULTS THAT MAY BE OBTAINED FROM USE OF THE CLOUD SERVICES. EXCEPT AS EXPRESSLY SET FORTH IN THIS SECTION, THE CLOUD SERVICES ARE PROVIDED “AS IS” AND CDATA DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.

#### 8. LIMITATION OF LIABILITY

**8.1 NO CONSEQUENTIAL DAMAGES.** IN NO EVENT SHALL EITHER PARTY OR ITS AGENTS AND SUPPLIERS (INCLUDING THEIR DIRECTORS, OFFICERS, EMPLOYEES, REPRESENTATIVES, AGENTS, AND SUPPLIERS) BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES, INCLUDING WITHOUT LIMITATION PROCUREMENT OF SUBSTITUTE PRODUCTS OR SERVICES OR LOSS OF PROFITS, REVENUE, DATA OR DATA USE, EVEN IF CDATA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. NOTHING IN THIS AGREEMENT WILL LIMIT CUSTOMER’S LIABILITY FOR MISAPPROPRIATION OF CDATA’S INTELLECTUAL PROPERTY RIGHTS IN THE SOFTWARE AND CLOUD SERVICES.

**8.2 DIRECT DAMAGES.** THE AGGREGATE, CUMULATIVE LIABILITY OF EACH PARTY (INCLUDING ITS DIRECTORS, OFFICERS, EMPLOYEES, REPRESENTATIVES, AGENTS, AND SUPPLIERS) UNDER THIS AGREEMENT SHALL BE LIMITED TO THE FEES PAID OR PAYABLE BY CUSTOMER TO CDATA DURING THE TWELVE-MONTH PERIOD PRIOR TO THE EVENT GIVING RISE TO ANY CLAIM, OR \$100 IF CUSTOMER IS USING A TRIAL OF THE CLOUD SERVICES. THE FOREGOING SHALL NOT LIMIT CUSTOMER’S PAYMENT OBLIGATIONS HEREUNDER.

#### 9. MISCELLANEOUS

**9.1 No Agency.** No agency, partnership, joint venture, or employment is created as a result of this Agreement and neither party has any authority of any kind to bind the other party in any respect whatsoever to any third party.

**9.2 Notices.** All notices under this Agreement must be in writing and will be deemed to have been duly given when received, if personally delivered; when receipt is electronically confirmed, if transmitted by facsimile or email; the day after it is sent, if sent for next day delivery by recognized overnight delivery service; and upon receipt, if sent by certified or registered mail, return receipt requested, to each party at its respective address provided on the initial Order Form.

**9.3 Enforceability.** If any provision of this Agreement is adjudicated invalid or unenforceable, this Agreement will be amended to the minimum extent necessary to achieve, to the maximum extent possible, the same legal and commercial effect originally intended by the parties. To the extent permitted by applicable law, the parties waive any provision of law that would render any clause of this Agreement prohibited or unenforceable in any respect.

**9.4 Force Majeure.** If the performance of this Agreement or any obligations (other than payment obligations) hereunder is prevented or interfered with by any act or condition beyond the reasonable control of a party hereto, that party upon giving prompt notice to the other party shall be excused from such performance during such occurrence.

**9.5 Assignment.** You may not, without our prior written consent, assign or novate this Agreement or any of your rights or obligations under this Agreement, or the Services or any of our Confidential Information, in whole or in part, by operation of law, sale of assets, merger or otherwise, to any other party, including any parent, subsidiary or affiliated entity. Your Change of Control will constitute an assignment for purposes of the preceding sentence. A “Change of Control” will include, but not be limited to, any merger, consolidation, amalgamation, reorganization or sale, transfer or exchange of the capital stock or equity interests of you in a transaction or series of transactions which results in the holders of your capital stock or equity interests holding less than 50% of the outstanding capital stock or equity interests immediately following such transaction(s).

**9.6 Integration.** This Agreement is the complete statement of the mutual understanding of the parties and supersedes and cancels all previous written and oral agreements, communications and other understandings relating to the subject matter of this Agreement. This Agreement shall supersede the terms of any purchase order or other business form. If accepted by CData in lieu of or in addition to CData’s Order Form, Customer’s purchase order shall be binding only as to the following terms: (a) the Cloud Services ordered and (b) the appropriately calculated fees due. Other terms shall be void.

**9.7 Amendment; Counterparts.** Except as otherwise stated in this Section 9.7, no supplement, modification, or amendment of this Agreement shall be binding, unless executed in writing by a duly authorized representative of each party. No waiver will be implied from conduct or failure to enforce or exercise rights under this Agreement, nor will any waiver be effective unless in a writing signed by a duly authorized representative on behalf of the party claimed to have waived. This Agreement may be executed by written signature or electronically and delivered in multiple counterparts, including facsimile, PDF, or other electronic counterparts, all of which will constitute one and the same instrument and agreement. From time to time CData may modify this Agreement. Unless another agreement between the parties supersedes this Agreement, changes become effective for Customer upon renewal of the then-current subscription term or entry into a new Order Form after the updated version of this Agreement goes into effect.

**9.8 Governing Law.** This Agreement shall be governed by the laws of the State of Delaware without regard to its conflict of laws provisions. This Agreement shall not be governed by the United Nations Convention on Contracts for the International Sale of Goods or the Uniform Computer Information Transactions Act.

#### Exhibit A

Support Terms - available upon request from [sales@cdata.com](mailto:sales@cdata.com).

*Last Revised October 7, 2026.*


# Cloudflare
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Cloudflare-Embedded



## Prerequisites

Before you can add the connection, you must obtain credentials from your Cloudflare account. Cloudflare supports two key types:

* **API Token**: A scoped token with specific permissions. Recommended for most use cases.
* **Global API Key**: The permanent key tied to your account. Requires your account email address.

To retrieve your credentials:

<Steps>
  <Step>
    Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and go to **My Profile** > **API Tokens**.
  </Step>

  <Step>
    To use an API Token, click **Create Token**, configure the required permissions, and copy the generated token.
  </Step>

  <Step>
    To use your Global API Key, navigate to the **API Keys** section and copy the key. You will also need the email address associated with your Cloudflare account.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Cloudflare to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Cloudflare* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set **Key Type** to **API Token** or **Global API Key**, depending on the credentials you are using.
  </Step>

  <Step>
    Enter your **API Key** (your API Token value or Global API Key value).
  </Step>

  <Step>
    If you are using a Global API Key, enter the **API Email** associated with your Cloudflare account. **API Email** is not required for token authentication.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Coda
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Coda-Embedded



## Prerequisites

To authenticate to Coda, you must generate an API token from your account settings:

<Steps>
  <Step>
    Log in to your Coda account and click your profile avatar in the upper-right or lower-left corner.
  </Step>

  <Step>
    Select **Account settings** or **Settings** from the menu.
  </Step>

  <Step>
    Scroll down to the **API settings** section and click **Generate API token**.
  </Step>

  <Step>
    Enter a name for the token and optionally add read/write restrictions for specific docs.
  </Step>

  <Step>
    Click **Generate API token**, then click **Copy token** to copy it to your clipboard.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Coda to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Coda* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Coda account settings.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Collaboflow
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Collaboflow-Embedded



## Prerequisites

Before you can add the connection, you must gather the following from your Collaboflow account.

<Steps>
  <Step>
    Log in to Collaboflow as an administrator.
  </Step>

  <Step>
    Open the **System Management Area** > **App Management** and note the **App Cd** (app code) of the workflow application you want to connect to.
  </Step>

  <Step>
    Note your **Instance**, which is the instance name in your Collaboflow API URL. The URL format is `https://cloud.collaboflow.com/{instance}/api/index.cfm`, so the Instance is the segment between the domain and `/api/index.cfm` (for example, *mycompany* in `https://cloud.collaboflow.com/mycompany/api/index.cfm`).
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Collaboflow to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Collaboflow* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **App Cd** obtained from Collaboflow.
  </Step>

  <Step>
    Enter the **Instance**, which is the instance portion of your Collaboflow URL.
  </Step>

  <Step>
    Enter the **URL** of the Collaboflow API endpoint, in the format *[https://cloud.collaboflow.com/\{instance}/api/index.cfm](https://cloud.collaboflow.com/\{instance}/api/index.cfm)* (for example, *[https://cloud.collaboflow.com/mycompany/api/index.cfm](https://cloud.collaboflow.com/mycompany/api/index.cfm)*).
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="APIKey">
    To use API Key authentication, you must generate an API key from your Collaboflow administrator account:

    <Steps>
      <Step>
        Open the **System Management Area** > **Environment Settings**.
      </Step>

      <Step>
        Scroll to the **REST API** section. Enter a client name, select **HTTP Header Authentication**, then click **+ Issue API Key**. Copy the **API Key** and store it securely.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **API Key** generated from your Collaboflow admin account.
      </Step>

      <Step>
        Enter the **User**, which is the Collaboflow username used to authenticate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User**, which is your Collaboflow username.
      </Step>

      <Step>
        Enter the **Password** used to authenticate to Collaboflow.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Constant Contact
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ConstantContact-Embedded



## Prerequisites

Before you can connect to Connect AI, you must register an OAuth application in the Constant Contact Developer Portal:

<Steps>
  <Step>
    Log in to the [Constant Contact Developer Portal](https://v3.developer.constantcontact.com) and click the **My Applications** tab.
  </Step>

  <Step>
    Click **New Application**.
  </Step>

  <Step>
    Enter a name for your application, then click **Create**.
  </Step>

  <Step>
    In your application's settings, add *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)* as a redirect URL.
  </Step>

  <Step>
    Make note of the **API Key** (used as the OAuth Client Id in Connect AI) and generate a **Client Secret**. The Client Secret is displayed only once, so copy it immediately and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Constant Contact to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Constant Contact* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** (your Constant Contact API Key) and **OAuth Client Secret**.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Constant Contact sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Constant Contact account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Kit (Formerly ConvertKit)
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-ConvertKit-Embedded



## Prerequisites

Before you can add the connection, you must obtain your API credentials from your Kit account:

<Steps>
  <Step>
    Log in to your Kit account and go to **Account Settings** > **Advanced** > **API**.
  </Step>

  <Step>
    Copy your **API Key** and **API Secret**, then store them securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Kit to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Kit* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Secret** from your Kit account.
  </Step>

  <Step>
    Enter the **API Key** from your Kit account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Copper
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Copper-Embedded



## Prerequisites

Before you can add the connection, you must generate an API key from your Copper account:

<Steps>
  <Step>
    Log in to your Copper CRM web application and navigate to **Settings** > **Integrations** > **API Keys**.
  </Step>

  <Step>
    Click **Generate API Key** and enter a label for the key.
  </Step>

  <Step>
    Copy the generated API key. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Copper to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Copper* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    Enter the **User Email** address associated with your Copper API key.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Discord
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Discord-Embedded



## Setup Guide

Follow these steps to connect Discord to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Discord* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    To use OAuth authentication, you must register an application in the Discord Developer Portal:

    <Steps>
      <Step>
        Visit the [Discord Developer Portal](https://discord.com/developers/applications) and click **New Application**.
      </Step>

      <Step>
        Provide a name for your application, then click **Create**.
      </Step>

      <Step>
        Navigate to the **OAuth2** section.
      </Step>

      <Step>
        Add a redirect URL and set it to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Copy the **Client ID** and **Client Secret**. Store the client secret securely. In Connect AI, the Client ID is entered as the **OAuth Client Id** and the Client Secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the Discord Developer Portal.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Discord sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Discord account and grant the requested permissions.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIKey">
    To use API Key authentication, you must set up a bot application in the Discord Developer Portal:

    <Steps>
      <Step>
        Visit the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application or select an existing one.
      </Step>

      <Step>
        Navigate to the **Bot** section.
      </Step>

      <Step>
        Create a bot if one does not exist.
      </Step>

      <Step>
        Copy the **Bot Token**.
      </Step>

      <Step>
        Configure the bot permissions as needed.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the bot token as the **API Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Egnyte
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Egnyte-Embedded



## Prerequisites

Before you can add the connection, you must register an OAuth application with Egnyte.

<Steps>
  <Step>
    Go to the [Egnyte Developers portal](https://developers.egnyte.com/) and sign in or create a developer account.
  </Step>

  <Step>
    Click **Create App** to begin registering a new application.
  </Step>

  <Step>
    Complete the required fields:

    * **App Name**–the name of your application.
    * **Redirect URL**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Submit the application. Once approved, Egnyte provides an **API Key** and **Secret** for your application. Make note of these values.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Egnyte to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Egnyte* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Domain**. This is the subdomain portion of your Egnyte URL. For example, if your Egnyte URL is *[https://acmeinc.egnyte.com/](https://acmeinc.egnyte.com/)*, the Domain is *acmeinc*.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Egnyte. The API Key is the OAuth Client Id, and the Secret is the OAuth Client Secret.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Egnyte sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Egnyte account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# EmailOctopus
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-EmailOctopus-Embedded



## Prerequisites

Before you can add the connection, you must obtain an API key from your EmailOctopus account:

<Steps>
  <Step>
    Log in to your EmailOctopus account and click **Integrations API** in the navigation menu.
  </Step>

  <Step>
    Click **API**, then click **Developer API**.
  </Step>

  <Step>
    Under **Your API Keys**, copy your API key and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect EmailOctopus to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *EmailOctopus* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your EmailOctopus account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Everhour
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Everhour-Embedded



## Prerequisites

Before you can add the connection, you must locate your API token in your Everhour account:

<Steps>
  <Step>
    Log in to your Everhour account and go to your **Profile** settings.
  </Step>

  <Step>
    Scroll to the bottom of the page to find your **API Token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Everhour to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Everhour* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** from your Everhour profile.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Exa
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Exa-Embedded



## Prerequisites

Before you can add the connection, you must generate an API key from your Exa account:

<Steps>
  <Step>
    Go to the [Exa dashboard](https://dashboard.exa.ai) and register for an account or log in.
  </Step>

  <Step>
    Navigate to the API settings section.
  </Step>

  <Step>
    Generate or copy your API key.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Exa to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Exa* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your Exa account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Figshare
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Figshare-Embedded



## Prerequisites

Before you can add the connection, you must generate a personal token from your Figshare account:

<Steps>
  <Step>
    Go to the [applications page](https://figshare.com/account/applications) at Figshare and log in.
  </Step>

  <Step>
    Under **Personal tokens**, enter a description and click **Create token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Figshare to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Figshare* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** using your Figshare personal token.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Float
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Float-Embedded



## Prerequisites

Before you can add the connection, you must generate an API access token from your Float account:

<Steps>
  <Step>
    Log in to your Float account as the Account Owner and navigate to **Company Settings**.
  </Step>

  <Step>
    Click **Integrations**, then **Float API**.
  </Step>

  <Step>
    Copy the API access token. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Float to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Float* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key** (your Float API access token) from the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Formsite
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Formsite-Embedded



## Prerequisites

Before you can add the connection, locate the following values in your Formsite account:

<Steps>
  <Step>
    Log in to your Formsite account and navigate to the **Admin Portal**.
  </Step>

  <Step>
    Go to the **API** or **Integrations** settings section.
  </Step>

  <Step>
    Generate a new API key or copy your existing key. This is entered as the **API Key** in Connect AI.
  </Step>

  <Step>
    Note your **Server** value. This is the number in your Formsite URL — for example, if your URL is `fs18.formsite.com`, the server number is `18`.
  </Step>

  <Step>
    Note your **User Directory**. This is your account directory, visible in the URL of your Formsite forms.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Formsite to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Formsite* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **API Key**—the API token from your Formsite account.
    * **Server Number**—the server number from your Formsite URL (for example, `18` for `fs18.formsite.com`).
    * **User Directory**—the user directory path for your Formsite account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Freshbooks
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Freshbooks-Embedded



## Prerequisites

Before you can add the connection, you need to register an OAuth application with FreshBooks. You must be signed in to a FreshBooks account that has admin access.

<Steps>
  <Step>
    Go to the [FreshBooks developer portal](https://my.freshbooks.com/#/developer) and sign in.
  </Step>

  <Step>
    Click **Create New App**.
  </Step>

  <Step>
    Complete the required fields:

    * **Name**–the name of your application.
    * **Description**–(optional) a short description of your application.
    * **Redirect URI**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save the application.
  </Step>

  <Step>
    On the application page, scroll to **App Settings** to find the **Client Id** and **Client Secret**. Make note of these values.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect FreshBooks to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *FreshBooks* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Connect AI, enter the **OAuth Client Id** and **OAuth Client Secret** obtained from FreshBooks.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the FreshBooks sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your FreshBooks account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Freshservice
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Freshservice-Embedded



## Setup Guide

Follow these steps to connect Freshservice to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Freshservice* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain**, which is the subdomain of your Freshservice account URL. For example, if your Freshservice URL is *[https://yourcompany.freshservice.com](https://yourcompany.freshservice.com)*, the **Domain** is *yourcompany*.
  </Step>

  <Step>
    Enter the Freshservice **API Key**. Find your API Key in the Freshservice portal under your **Profile settings** in the top-right corner. You must be an account administrator to access the API key.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Freshteam
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Freshteam-Embedded



## Setup Guide

Follow these steps to connect Freshteam to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Freshteam* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Account Name**, which is the subdomain of your Freshteam account URL. For example, if your Freshteam URL is *[https://yourcompany.freshteam.com](https://yourcompany.freshteam.com)*, the **Account Name** is *yourcompany*.
  </Step>

  <Step>
    Enter the Freshteam **API Key**. Find your API Key in the Freshteam portal under your **Profile settings**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Front
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Front-Embedded



## Prerequisites

Before you can add the connection, you must create an OAuth application in Front. You must be a Front admin to do this.

<Steps>
  <Step>
    In Front, go to **Settings** > **Company** > **Developers**.
  </Step>

  <Step>
    Click **Create app**, enter an **App name** and **Short description**, then click **Save**.
  </Step>

  <Step>
    Click your new app, open the **Features** tab, click **Add feature**, then click **OAuth** and **Enable OAuth**. The **Client ID** and **Client secret** appear immediately. Copy them and store the client secret securely.
  </Step>

  <Step>
    Click **Add Redirect URL** and enter *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Front to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Front* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication

<Steps>
  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Front.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Front sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Front account and grant the requested permissions.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# GetResponse
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-GetResponse-Embedded



## Setup Guide

Follow these steps to connect GetResponse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *GetResponse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Auth Scheme, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="APIKey">
    To use API Key authentication, retrieve your X-Auth-Token from your GetResponse account:

    <Steps>
      <Step>
        Log in to [app.getresponse.com](https://app.getresponse.com), click your profile avatar in the upper-right corner, and select **My account**.
      </Step>

      <Step>
        Select **Use GetResponse API**.
      </Step>

      <Step>
        Copy the X-Auth-Token displayed on the page.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the X-Auth-Token as the **API Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    To use OAuth authentication, you must register an application with GetResponse:

    <Steps>
      <Step>
        Go to [app.getresponse.com/authorizations](https://app.getresponse.com/authorizations) and register a new application.
      </Step>

      <Step>
        Complete the required fields:

        * **Name**–the name of your application.
        * **Short description**–a brief description of your application.
        * **Redirect URL**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        After saving, click the application to view its credentials. Make note of the **client\_id** and **client secret**. In Connect AI, the client\_id is entered as the **OAuth Client Id** and the client secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from GetResponse.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the GetResponse sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your GetResponse account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# GitLab
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-GitLab-Embedded



## Setup Guide

Follow these steps to connect GitLab to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *GitLab* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    To use OAuth authentication, you need to register an OAuth application with GitLab. You can register either a user-owned application or a group-owned application:

    <Steps>
      <Step>
        Open the **Applications** page in GitLab:

        * **User-owned**–select your avatar in the upper-right corner, click **Edit profile**, then select **Applications** from the left sidebar.
        * **Group-owned**–open the group, then in the left sidebar select **Settings** > **Applications**.
      </Step>

      <Step>
        Click **Add new application**.
      </Step>

      <Step>
        Complete the required fields:

        * **Name**–the name of your application.
        * **Redirect URI**–set this to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
        * **Confidential**–leave this checkbox selected.
        * **Scopes**–select the OAuth 2.0 scopes your integration needs (for example, `api`, `read_user`, `read_api`, `read_repository`).
      </Step>

      <Step>
        Click **Save application**.
      </Step>

      <Step>
        On the application page, make note of the **Application ID** and **Secret**. The Secret is only shown once, so copy it immediately. In Connect AI, the Application ID is entered as the **OAuth Client Id** and the Secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from GitLab.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the GitLab sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your GitLab account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIKey">
    To use API Key authentication, first create a personal access token in GitLab:

    <Steps>
      <Step>
        Select your avatar in the upper-right corner and click **Edit profile**.
      </Step>

      <Step>
        In the left sidebar, select **Access Tokens** (or **Access** > **Personal access tokens** on newer GitLab versions), then click **Add new token**.
      </Step>

      <Step>
        Complete the required fields:

        * **Token name**–a descriptive name for the token.
        * **Expiration date**–required by GitLab.
        * **Scopes**–select the scopes your integration needs. Use `api` for full read/write API access, or narrower read-only scopes such as `read_api`, `read_user`, and `read_repository`.
      </Step>

      <Step>
        Click **Create personal access token**.
      </Step>

      <Step>
        Copy the token immediately and store it securely. GitLab only displays the token once.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **API Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Gong
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Gong-Embedded



## Prerequisites

Before you can add the connection, you need to generate API credentials from your Gong account. You must be a Gong administrator to do this.

<Steps>
  <Step>
    Log in to Gong and go to **Admin center** > **Settings** > **Ecosystem** > **API**.
  </Step>

  <Step>
    Click **Get API Key** (or **Create**) to generate a new key.
  </Step>

  <Step>
    Copy the **Access Key** and **Access Key Secret** and store them securely. Gong only displays the Access Key Secret once.
  </Step>

  <Step>
    Note the **Base URL** displayed at the top of the Gong API page. You use this value as the **Domain** when you set up the connection.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Gong to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Gong* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain**, which is the Base URL shown at the top of the Gong API page.
  </Step>

  <Step>
    Enter the **API Key**, which is the Access Key generated in Gong.
  </Step>

  <Step>
    Enter the **API Secret**, which is the Access Key Secret generated in Gong.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Forms
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-GoogleForms-Embedded



## Prerequisites

Before you can add the connection, you must create an OAuth app in the Google Cloud Console to obtain a Client ID and Client Secret:

<Steps>
  <Step>
    Navigate to [https://console.cloud.google.com](https://console.cloud.google.com) and sign in.
  </Step>

  <Step>
    Create or select a project, then navigate to **APIs & Services** > **Library** and enable the **Google Forms API**.
  </Step>

  <Step>
    Navigate to **APIs & Services** > **Credentials** and click **Create credentials** > **OAuth client ID**.
  </Step>

  <Step>
    Select **Web application** as the application type.
  </Step>

  <Step>
    Under **Authorized redirect URIs**, add *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Create**. Copy the **Client ID** and **Client Secret** and store them securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Google Forms to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Forms* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the prerequisites.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Google sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Google account and provide the requested permissions.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Grafana
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Grafana-Embedded



## Prerequisites

To authenticate to Grafana, you must provide a Service Account Token or an API Key:

<Steps>
  <Step>
    In your Grafana account, open the side menu and click **Administration**, then select **Users and Access** > **Service accounts**.
  </Step>

  <Step>
    Create a new service account, then open its page and click **Add service account token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

<Note>On older versions of Grafana, use an API Key. If your instance was recently updated, there is an option to migrate API keys to service accounts under the **API Keys** section.</Note>

## Setup Guide

Follow these steps to connect Grafana to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Grafana* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key**, which is the Service Account Token or API Key obtained from your Grafana instance.
  </Step>

  <Step>
    Enter the **Domain**, which is the subdomain portion of your Grafana URL. For example, if your Grafana URL is *[https://acmeinc.grafana.net/](https://acmeinc.grafana.net/)*, the Domain is *acmeinc*.
  </Step>

  <Step>
    Enter the **URL** of your Grafana instance (for example, *[https://acmeinc.grafana.net/](https://acmeinc.grafana.net/)*).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Guru
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Guru-Embedded



## Prerequisites

Before you can add the connection, you need a Guru account username and an API token to authenticate.

<Steps>
  <Step>
    Log in to your Guru account.
  </Step>

  <Step>
    Go to **Settings** > **API**.
  </Step>

  <Step>
    Click **Create New API Token**.
  </Step>

  <Step>
    Copy the generated API token and store it securely. Guru only displays the token once.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Guru to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Guru* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **User**, which is the Guru account username or email address used to authenticate.
  </Step>

  <Step>
    Enter the **Password**, which is the API token used to authenticate to Guru.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Hive
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Hive-Embedded



## Prerequisites

Before you can add the connection, you must locate your API key and user ID from your Hive account:

<Steps>
  <Step>
    Log in to your Hive account and open the main menu in the top-right corner.
  </Step>

  <Step>
    Select **API Information**.
  </Step>

  <Step>
    Copy your **API Key** and **User ID**. Store the API key securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Hive to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Hive* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **User Id** from your Hive account.
  </Step>

  <Step>
    Enter your **API Key** from your Hive account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Jotform
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-JotForm-Embedded



## Prerequisites

Before you can add the connection, you must create an API key from your Jotform account:

<Steps>
  <Step>
    Log in to your Jotform account and navigate to **My Account**, then **API Section**.
  </Step>

  <Step>
    Click **Create a New API Key**. Copy the key and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Jotform to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Jotform* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    If you are connecting to a Jotform Enterprise account, enter your **Team Id**.
  </Step>

  <Step>
    Enter your **API Key** from the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Jumpseller
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Jumpseller-Embedded



## Prerequisites

Before you can add the connection, you must register an OAuth application with Jumpseller:

<Steps>
  <Step>
    Log in to your Jumpseller admin and navigate to **Apps**, then click **Developers > Add Application**. Fill out the application form and set the **Redirect URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    After saving, Jumpseller assigns your application a **Client ID** and **Client Secret**. Copy both values and store them securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Jumpseller to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Jumpseller* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Jumpseller.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Jumpseller sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Jumpseller account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Klipfolio
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Klipfolio-Embedded



## Prerequisites

Before you can add the connection, you must generate an API key from the Klipfolio Dashboard app:

<Steps>
  <Step>
    Log in to the Klipfolio Dashboard app and open the **My Profile** page. If you are an administrator with the **user.manage** permission, you can instead generate a key for any user from the **Users** page.
  </Step>

  <Step>
    Generate an **API key**, then copy it and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Klipfolio to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Klipfolio* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Klipfolio account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MailerLite
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-MailerLite-Embedded



## Prerequisites

Before you can add the connection, you must generate an API key from your MailerLite account:

<Steps>
  <Step>
    Log in to your MailerLite account and navigate to **Integrations** > **Developer API**.
  </Step>

  <Step>
    Click **Generate new token**, enter a name for the token, and click **Create token**.
  </Step>

  <Step>
    Copy the token and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect MailerLite to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MailerLite* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your MailerLite account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# iContact
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-iContact-Embedded



## Prerequisites

Before you can add the connection, you must create a custom API integration in your iContact account:

<Steps>
  <Step>
    Log in to your iContact account and click the dropdown menu in the upper-right corner, then select **Settings and Billing**.
  </Step>

  <Step>
    Click **iContact Integrations**.
  </Step>

  <Step>
    Click the **Create** button next to **Custom API Integrations**.
  </Step>

  <Step>
    Under the **Getting Connected** section, note your **API Application ID** (App Id), **Username**, and **Password**.
  </Step>

  <Step>
    Note your **Account Id** from the **Account Information** section of the same page.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect iContact to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *iContact* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Account Id** and **App Id** obtained from your iContact Custom API Integration page.
  </Step>

  <Step>
    Set the **User** to your iContact username and the **Password** to your iContact password.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dataverse
Source: https://docs.cloud.cdata.com/en/Data-Sources/CDS-Embedded



## Setup Guide

Follow these steps to connect Dataverse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dataverse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Organization URL** to your organization's Dataverse data (for example, `https://abc123.crm.dynamics.com/`).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Select a **Schema** from the drop down. System is used for optimal performance, while Entities provides more user-friendly table names.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Dataverse sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Dataverse account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** that you will use to access data.
      </Step>

      <Step>
        Enter your **OAuth Client Id**.
      </Step>

      <Step>
        Enter your **OAuth Client Secret**.
      </Step>

      <Step>
        Enter your **OAuth JWT Cert**. This is a multi-line key.
      </Step>

      <Step>
        Select your **OAuth JWT Cert Type** from the drop down.
      </Step>

      <Step>
        Select a **Schema** from the drop down. System is used for optimal performance, while Entities provides more user-friendly table names.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Dataverse, see [this information page](https://cdn.cdata.com/help/UVM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# CSV
Source: https://docs.cloud.cdata.com/en/Data-Sources/CSV-Embedded



## Setup Guide

Follow these steps to connect CSV to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *CSV* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI** for the CSV resource location.
  </Step>

  <Step>
    (Optional) Enter the **FMT**. This specifies the file format that the provider uses to parse all text files. The default value is CsvDelimited.
  </Step>

  <Step>
    (Optional) Toggle on **Aggregate Files**. This specifies whether the provider aggregates all files with the same schema in the specified folder into a single table called AggregatedFiles.
  </Step>

  <Step>
    (Optional) Toggle on **Include Column Headers**. This specifies whether the provider derives column names from the first row of each file.
  </Step>

  <Step>
    Select the **Connection Type**, which specifies the file storage service, server, or file access protocol through which your CSV files are stored and retrieved. Then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Connection Types

<Tabs>
  <Tab title="Amazon S3">
    <Steps>
      <Step>
        Select the **AWS Region** from the drop-down list. This is the hosting region for your Amazon Web Services.
      </Step>

      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme** to use when connecting to remote services. Then select the tab for your authentication scheme and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AwsRootKeys">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsEC2Roles">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsIAMRoles">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Role ARN**. This is the Amazon Resource Name of the role to use when authenticating.
          </Step>

          <Step>
            (Optional) Enter the **AWS External Id**. This is a unique identifier that might be required when you assume a role in another account.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsTempCredentials">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to AWS. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Session Token**. See the [AWS Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) for more information about the session token.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsCredentialsFile">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Keycloak">
        <Steps>
          <Step>
            Enter the **Keycloak Realm URL**. This specifies the full URL to the Keycloak server, including the specific realm used for authentication and authorization.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Blob Storage">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2 SSL">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Files">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Box">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Dropbox">
    <Steps>
      <Step>
        (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTP">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTPS">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Google Cloud Storage">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Google Drive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS Secure">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTP">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTPS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="IBM Object Storage Source">
    <Steps>
      <Step>
        Enter the **Api Key** used to identify the user to the IBM Cloud.
      </Step>

      <Step>
        Enter the **Region**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from the security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneDrive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneLake">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Oracle Cloud Storage">
    <Steps>
      <Step>
        Enter the hosting **Region** for your S3-like Web Services.
      </Step>

      <Step>
        Enter the **Oracle Namespace**. This is the Oracle Cloud Object Storage namespace to use.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SFTP">
    <Steps>
      <Step>
        Select the **SSH Auth Mode**, which is the type of authentication to use when connecting to remote services. Then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Password">
        <Steps>
          <Step>
            Enter the **SSH User** used to authenticate to the SFTP server.
          </Step>

          <Step>
            Enter the **SSH Password** used to authenticate to the SFTP server.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Public_Key">
        <Steps>
          <Step>
            Enter the **SSH Client Cert**, which is the name of the certificate store for the client certificate.
          </Step>

          <Step>
            Select the **SSH Client Cert Type**, which is the type of key store containing the client certificate.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Password**. This is the password for the client certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Subject**. This is the subject of the SSH client certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the CSV tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint SOAP">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and CSV, see [this information page](https://cdn.cdata.com/help/RVM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# CockroachDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/CockroachDB-Embedded



## Prerequisites

#### Whitelist CData IPs

To establish a connection to CockroachDB, you need to allow access to CockroachDB via CData’s IP. When hosting CockroachDB behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure CockroachDB Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect CockroachDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *CockroachDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Password**—the user password
    * **User**—the CockroachDB username for authentication
    * **Server**—the host name or IP address of the CockroachDB server
    * **Database**—the name of the CockroachDB database you want to access, set as the default database if not specified
    * **Port**—the port for connecting to the CockroachDB server
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and CockroachDB, see [this information page](https://cdn.cdata.com/help/HJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Confluence
Source: https://docs.cloud.cdata.com/en/Data-Sources/Confluence-Embedded



## Setup Guide

Follow these steps to connect Confluence to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Confluence* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **URL**—Set to the URL to your Jira endpoint in the form `https://[YourSiteName].atlassian.net/`.
        * **OAuth Client Id**—Set to the client Id in your app settings.
        * **OAuth Client Secret**—Set to the client secret in your app settings.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Confluence sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Confluence account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Note>
      Basic authentication is only applicable for Server instances. For Cloud instances, use APIToken authentication.
    </Note>

    <Steps>
      <Step>
        Enter the following information:

        * **URL**—Set to the URL to your Jira endpoint in the form `https://[YourSiteName].atlassian.net/`.
        * **User**—the Confluence username for authentication.
        * **Password**—the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIToken">
    <Note>
      APIToken is only applicable for Cloud instances. For Server instances, use Basic authentication.
    </Note>

    <Steps>
      <Step>
        Enter the following information:

        * **URL**—Set to the URL to your Jira endpoint in the form `https://[YourSiteName].atlassian.net/`.
        * **User**—the Confluence username for authentication.
        * **API Token**—the API token for the current user. To create an API token, go to the **Security** tab of your Atlassian account and click **Create and manage API tokens**. On the **API Tokens** page, click **Create API token**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Crowd">
    <Steps>
      <Step>
        Enter the following information:

        * **URL**—Set to the URL to your Jira endpoint in the form `https://[YourSiteName].atlassian.net/`.
        * **User**—The Crowd user account.
        * **Password**—The password associated with the Crowd account.
        * **SSO Login URL**—The login URL associated with the Crowd account. You can find the IDP URL by navigating to **your application > SSO > SSO information > Identity provider single sign-on URL**.
        * **SSO Exchange URL**—The URL used to exchange the SAML token for Confluence cookies. This URL can have the following formats:
          * https\:///plugins/servlet/samlconsumer
          * https\:///plugins/servlet/samlsso
        * **SSO App Name**—The name of the application in which SSO is enabled.
        * **SSO App Password**—The password of the application in which SSO is enabled.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the following information:

        * **URL**—Set to the URL to your Jira endpoint in the form `https://[YourSiteName].atlassian.net/`.
        * **User**—The Okta user account.
        * **Password**—The password associated with the Okta account.
        * **SSO Login URL**—Set to the URL used by the SSO provider.
        * **SSO Properties**—(Optional) This is needed if you use MFA, applications that override the Okta requests, or a proxy. Otherwise it can be left blank.
        * **SSO Exchange URL**—The URL used to exchange the SAML token for Confluence cookies. This URL can have the following formats:
          * https\:///plugins/servlet/samlconsumer
          * https\:///plugins/servlet/samlsso
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PAT">
    <Steps>
      <Step>
        In your Atlassian account, go to **Profile** > **Personal Access Tokens** > **Create token**. Copy and paste the PAT here.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Confluence, see [this information page](https://cdn.cdata.com/help/UGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Cosmos DB
Source: https://docs.cloud.cdata.com/en/Data-Sources/CosmosDB-Embedded



## Setup Guide

Follow these steps to connect Cosmos DB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Cosmos DB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Cosmos DB account URL **Account Endpoint**. You can find this URL under the **Keys** blade of the Cosmos DB account.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AccountKey">
    <Steps>
      <Step>
        Enter the master key token or resource token for connecting to the Cosmos DB REST API in the **Account Key** field.
      </Step>

      <Step>
        Use the **Token Type** field to specify whether the token you entered in the **Account Key** field is a **master** or **resource** token.
      </Step>

      <Step>
        In Cosmos DB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Cosmos DB account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Cosmos DB account for OAuth.
      </Step>

      <Step>
        In Cosmos DB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        Enter the **OAuth Client Id** found in your application settings.
      </Step>

      <Step>
        Enter your **OAuth Client Secret**.
      </Step>

      <Step>
        In Cosmos DB, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Cosmos DB, see [this information page](https://cdn.cdata.com/help/EHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Couchbase
Source: https://docs.cloud.cdata.com/en/Data-Sources/Couchbase-Embedded



## Setup Guide

Follow these steps to connect Couchbase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Couchbase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select which **Couchbase Service** to connect to, **Analytics** or **N1QL**.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Couchbase username for authentication.
        * **Password**—the user password.
        * **Server**—the host name or IP address of the Couchbase server or servers to which you are connecting.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Couchbase, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SSLCertificate">
    <Steps>
      <Step>
        Enter the following information:

        * **SSL Client Cert**—the contents of your certificate file. A sample is displayed.
        * **SSL Client Cert Password**—the client certificate password if it is encrypted.
        * **Server**—the host name or IP address of the Couchbase server or servers to which you are connecting.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>

      <Step>
        In Couchbase, add the Connect AI static IP addresses to your connection whitelist.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Couchbase, see [this information page](https://cdn.cdata.com/help/CKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Cvent
Source: https://docs.cloud.cdata.com/en/Data-Sources/Cvent-Embedded



## Prerequisites

Before obtaining OAuth credentials, you need to create a custom OAuth application in Cvent if you do not already have one.

To create an OAuth application in Cvent:

<Steps>
  <Step>
    Navigate to the [Cvent Developer Portal's Applications page](https://developers.cvent.com/) and click **Create application**.
  </Step>

  <Step>
    Select the **Machine to Machine** application type.
  </Step>

  <Step>
    Under **Application name**, specify a name for the application.
  </Step>

  <Step>
    Click **Select scopes** and select all of the scopes you want to add to your application. You are limited to the scopes allowed by the Workspace.
  </Step>

  <Step>
    Click **Save** to create the application.
  </Step>

  <Step>
    Click **View Applications** to return to the Applications page.
  </Step>
</Steps>

Note the values of the **Client ID** and **Client secret**. You will use these below to authenticate to Cvent.

## Setup Guide

Follow these steps to connect Cvent to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Cvent* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuthClientId** from the prerequisites.
  </Step>

  <Step>
    Enter the **OAuthClientSecret** from the prerequisites.
  </Step>

  <Step>
    (Optional) Enter the **Scope** of the authenticating user's access to the application. This can be done when you create the OAuth application.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dynamics 365 Business Central
Source: https://docs.cloud.cdata.com/en/Data-Sources/D365BusinessCentral-Embedded



## Setup Guide

Follow these steps to connect Dynamics 365 Business Central to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dynamics 365 Business Central* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your organization's URL in the **Organization URL** field (for example, `https://businesscentral.dynamics.com/abc123/`).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter the name of the Company to connect to, if more than one company exists in your organization.
      </Step>

      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Dynamics 365 Business Central sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Dynamics 365 Business Central account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        Enter **OAuth Client Id** in your application settings.
      </Step>

      <Step>
        Enter your **OAuth Client Secret** or your **OAuth JWT Cert**.
      </Step>

      <Step>
        Select your **OAuth JWT Cert Type** from the drop down.
      </Step>

      <Step>
        (Optional) Enter your **OAuth JWT Cert Password** if you are using an encrypted OAuth JWT Cert.
      </Step>

      <Step>
        (Optional) Enter the name of the Company to connect to, if more than one company exists in your organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Dynamics 365 Business Central, see [this information page](https://cdn.cdata.com/help/FBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# DB2
Source: https://docs.cloud.cdata.com/en/Data-Sources/DB2-Embedded



## Setup Guide

Follow these steps to connect DB2 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *DB2* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the name of the **Server** running DB2.
  </Step>

  <Step>
    Enter the **Port** the DB2 is listening on.
  </Step>

  <Step>
    Enter the name of the DB2 **Database**.
  </Step>

  <Step>
    (Optional) Select whether you want to **Use SSL**.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="USRIDPWD">
    <Steps>
      <Step>
        To authenticate with user credentials, enter the following information:

        * **User**—enter the username of a user with access to the database.
        * **Password**—enter the password of a user with access to the database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="EUSRIDPWD">
    <Steps>
      <Step>
        To authenticate with encrypted user credentials, select **EUSRIDPWD** and enter the following information:

        * **User**—enter the username of a user with access to the database.
        * **Password**—enter the password of a user with access to the database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="IBMIAMAuth">
    <Steps>
      <Step>
        To authenticate using the API key of an application that connects to it, select **IBMIAMAuth** and enter the following information:

        * **User**—enter the IBM ID or service ID of a DB2 server user.
        * **Password**—enter the API key associated with the application that requires access to the DB2 database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Databricks
Source: https://docs.cloud.cdata.com/en/Data-Sources/Databricks-Embedded



## Setup Guide

Follow these steps to connect Databricks to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Databricks* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="PersonalAccessToken">
    <Steps>
      <Step>
        Enter your Databricks access token into the **Token** field. To obtain the token, navigate to the **User Settings** page of your Databricks instance and open the **Access Tokens** tab.
      </Step>

      <Step>
        Enter the Databricks **Catalog** if you are using Databricks Unity Catalog. Otherwise, leave the default value.
      </Step>

      <Step>
        Enter the **HTTP Path** component of the URL endpoint.
      </Step>

      <Step>
        Enter the **Server** URL or IP address of the Databricks instance .
      </Step>

      <Step>
        (Optional) Enter the name of the **Database** to connect to.
      </Step>

      <Step>
        In Databricks, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User** name for Databricks.
      </Step>

      <Step>
        Enter your Databricks access token into the **Token** field. To obtain the token, navigate to the **User Settings** page of your Databricks instance and open the **Access Tokens** tab.
      </Step>

      <Step>
        Enter the Databricks **Catalog** if you are using Databricks Unity Catalog. Otherwise, leave the default value.
      </Step>

      <Step>
        Enter the **HTTP Path** component of the URL endpoint.
      </Step>

      <Step>
        Enter the **Server** URL or IP address of the Databricks instance .
      </Step>

      <Step>
        (Optional) Enter the name of the **Database** to connect to.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant Id** of your Azure application.
      </Step>

      <Step>
        Enter the **Azure Client Id** for your Azure application.
      </Step>

      <Step>
        Enter the **Azure Client Secret** corresponding to the above Azure Client Id.
      </Step>

      <Step>
        Enter the **Azure Subscription Id** of your Microsoft Azure Databricks Service Workspace.
      </Step>

      <Step>
        Enter the **Azure Resource Group** name of your Microsoft Azure Databricks Service Workspace.
      </Step>

      <Step>
        Enter the **Azure Workspace** of your Microsoft Azure Databricks Service Workspace.
      </Step>

      <Step>
        Enter the **Catalog** if you are using Databricks Unity Catalog. Otherwise, leave the default value.
      </Step>

      <Step>
        Enter the **HTTP Path** component of the URL endpoint.
      </Step>

      <Step>
        Enter the **Server** URL or IP address of the Databricks instance .
      </Step>

      <Step>
        (Optional) Enter the name of the **Database** to connect to.
      </Step>

      <Step>
        In Databricks, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Catalog** if you are using Databricks Unity Catalog. Otherwise, leave the default value.
      </Step>

      <Step>
        Enter the **HTTP Path** component of the URL endpoint.
      </Step>

      <Step>
        Enter the **Server** URL or IP address of the Databricks instance .
      </Step>

      <Step>
        (Optional) Enter the name of the **Database** to connect to.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Databricks sign-in page in a new tab.
      </Step>

      <Step>
        In Databricks, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Private Cloud Connector Connection

Databricks is a supported connector with Private Cloud Connector, which acts as a bridge between your on-premises data and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information. Once you set up the gateway, you can select the **Connection Type** of **Private Cloud Connector**. Then enter **Location Name** of the gateway and the Databricks authentication information.

## More Information

For more information about interactions between Connect AI and Databricks, see [this information page](https://cdn.cdata.com/help/LKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Docusign
Source: https://docs.cloud.cdata.com/en/Data-Sources/DocuSign-Embedded



## Prerequisites

Before you can establish a connection with Docusign using the OAuth authentication method, you must create and configure a custom OAuth application.

<Steps>
  <Step>
    In Docusign, navigate to **Settings** > **Integrations** > **Apps and Keys**.
  </Step>

  <Step>
    Click **Add App and Integration Key** and name your application.
  </Step>

  <Step>
    Click **Create App**.
  </Step>

  <Step>
    In **General Info**, note the **Integration Key** field. You need to copy and paste this key into the **OAuthClientId** field in Connect AI.
  </Step>

  <Step>
    In **Authentication** > **Secret Keys**, click **Add Secret Key**. You need to copy and paste this key into the **OAuth Client Secret** field in Connect AI.
  </Step>

  <Step>
    In **Additional Settings** > **Redirect URIs**, click **Add URI**. Enter `https://oauth.cdata.com/oauth/` as the redirect URI.
  </Step>

  <Step>
    (Optional) If you are using JWT authentication, in **Service Integration** > **RSA Keypairs**, click **Generate RSA** to generate an RSA public key and private key. You need to copy and paste the private key into the **OAuth JWT Cert** field in Connect AI.
  </Step>

  <Step>
    (Optional) If you are using JWT authentication, in the **Apps and Keys** home page, note **My Account Information** > **User ID**. You need to copy and paste this key into the **OAuth JWT Subject** field in Connect AI.
  </Step>
</Steps>

Refer to the [Docusign documentation](https://developers.docusign.com/platform/build-integration/) for more details about building a Docusign integration.

## Setup Guide

Follow these steps to connect Docusign to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Docusign* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        For **OAuth Client Id**, copy and paste the Docusign integration key you created in the prerequisites.
      </Step>

      <Step>
        For **OAuth Client Secret**, copy and paste the secret key you created in the prerequisites.
      </Step>

      <Step>
        The **Callback URL** is the redirect URI for your OAuth app. On Connect AI, this is `https://oauth.cdata.com/oauth/`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Docusign sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Docusign account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        For **OAuth JWT Cert**, copy and paste the RSA private key you generated in the prerequisites.
      </Step>

      <Step>
        For **OAuth JWT Subject**, copy and paste your Docusign user Id. Retrieve your user Id in Docusign by navigating to **Settings** > **Apps and Keys** > **My Account Information** > **User ID**.
      </Step>

      <Step>
        For **OAuth JWT Issuer**, copy and paste the Docusign integration key you created in the prerequisites.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Docusign, see [this information page](https://cdn.cdata.com/help/UCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Domino
Source: https://docs.cloud.cdata.com/en/Data-Sources/Domino-Embedded



## Setup Guide

Follow these steps to connect Domino to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Domino* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Domino, if the Proton component has not been installed, install it before continuing. See the Domino documentation for instructions on acquiring and installing Proton or the AppDev pack.
  </Step>

  <Step>
    Enter the following information:

    * **SSL Client Cert**—the content of the TLS/SSL client certificate file for client authentication
    * **SSL Client Cert Type**—the format of the TLS/SSL client certificate file
    * **SSL Client Cert Password**—the Private Key Password. Only required when your Private Key has been encrypted.
    * **SSL Server Cert**—You only need to set this if you are using a certificate that is not issued by a certificate authority. You can also set this to '\*' to accept all certificates (not recommended for production use cases).
    * **Database**—the name of the Domino database file, including the `.nsf` extension
    * **Port**—the port number that the Proton service is listening on
    * **Server**—the hostname or IP address of the Domino server
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Domino, see [this information page](https://cdn.cdata.com/help/JKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dropbox
Source: https://docs.cloud.cdata.com/en/Data-Sources/Dropbox-Embedded



## Setup Guide

Follow these steps to connect Dropbox to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dropbox* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Impersonate User Mode** the provider uses when making API calls on behalf of a user or administrator: **User**, **Admin**, or **None**.
  </Step>

  <Step>
    Enter the **Impersonate User Id** which specifies the Dropbox User Id to impersonate when acting on behalf of a team member or administrator. This field is required if you select **User** or **Admin** for **Impersonate User Mode**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  The directions above assume you are using CData's embedded OAuth app. If you want to create a custom OAuth app, see [Creating a Custom OAuth App](https://cdn.cdata.com/help/OFM/cloud/default.htm#pg_oauthcustomappcreate). After you have created a custom OAuth app, go to the **Advanced Settings** tab and enter the **OAuth Client Id** and **OAuth Client Secret** you obtained from the custom OAuth app.
</Note>

## More Information

For more information about interactions between Connect AI and Dropbox, see [this information page](https://cdn.cdata.com/help/OFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dynamics 365
Source: https://docs.cloud.cdata.com/en/Data-Sources/Dynamics365-Embedded



## Setup Guide

Follow these steps to connect Dynamics 365 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dynamics 365* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your organization's URL in the **Organization URL** field (for example, `https://businesscentral.dynamics.com/abc123/`).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Select your edition of Dynamics 365 in the **Edition** drop-down menu.
      </Step>

      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Dynamics 365 sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Dynamics 365 account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        Enter **OAuth Client Id** in your application settings.
      </Step>

      <Step>
        Enter your **OAuth Client Secret** or your **OAuth JWT Cert**.
      </Step>

      <Step>
        Select your edition of Dynamics 365 in the **Edition** drop-down menu.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Dynamics 365, see [this information page](https://cdn.cdata.com/help/LJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dynamics CRM
Source: https://docs.cloud.cdata.com/en/Data-Sources/DynamicsCRM-Embedded



## Prerequisites

In Dynamics CRM, [create a custom OAuth application](#create-a-custom-oauth-application) (if you are not using embedded credentials).

## Setup Guide

Follow these steps to connect Dynamics CRM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dynamics CRM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **CRM Version**—the CRM version. Choose either **CRM2011+** or **CRMOnline** from the drop-down list.
    * **URL**—the root URL of the organization. The formatting of this URL depends on the version of CRM that you use.
  </Step>

  <Step>
    (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
  </Step>

  <Step>
    (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Dynamics CRM sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Dynamics CRM account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## Create a Custom OAuth Application

Follow these steps to create a custom OAuth Application in Dynamics CRM:

<Steps>
  <Step>
    Open your Azure portal and open the navigation pane. Select **Azure Active Directory**, then **App Registrations**.
  </Step>

  <Step>
    Click **New Registration**.
  </Step>

  <Step>
    Enter the following information:

    * **Name**—a name for the application (for example, *Connect AI*).
    * **Supported account types**—select **Accounts in any organization directory**.
    * **Redirect URI**—select **Web** and enter *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*
  </Step>

  <Step>
    Click **Register** to create the application.
  </Step>

  <Step>
    In the application view, select **Certificates & Secrets**.
  </Step>

  <Step>
    Select **New Client Secret**, set a duration, and save it. When the key value appears, copy it down to use when establishing the connection.
  </Step>

  <Step>
    Select **API permissions** and click **Add a permission**.
  </Step>

  <Step>
    Select **Dynamics CRM** and select **Delegated permissions**. Select **user\_impersonation** in the permissions list.
  </Step>

  <Step>
    Click **Add permissions** to save your changes.
  </Step>

  <Step>
    Select **Overview** and copy down the value for **Application (client) ID**.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Dynamics CRM, see [this information page](https://cdn.cdata.com/help/RMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Dynamics NAV
Source: https://docs.cloud.cdata.com/en/Data-Sources/DynamicsNAV-Embedded



## Setup Guide

Follow these steps to connect Dynamics NAV to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Dynamics NAV* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** to the Microsoft Dynamics NAV server organization root. For example, *[http://MyServer:7048](http://MyServer:7048)*.
  </Step>

  <Step>
    Enter the **Server Instance**, which is the instance of the Dynamics NAV server. For example, *DynamicsNAV71*.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Negotiate">
    Set to **Negotiate** if you want the provider to negotiate an authentication mechanism with the server.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="NTLM">
    Set to **NTLM** to use your Windows credentials to authenticate.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    Set to **Basic** to use HTTP Basic authentication.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Digest">
    Set to **Digest** to use HTTP Digest authentication.

    <Steps>
      <Step>
        Enter the **User**, which specifies the authenticating user's Id.
      </Step>

      <Step>
        Enter the **Password**, which specifies the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this authentication method.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Dynamics NAV, see [this information page](https://cdn.cdata.com/help/CNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# eBay
Source: https://docs.cloud.cdata.com/en/Data-Sources/Ebay-Embedded



## Setup Guide

Follow these steps to connect eBay to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *eBay* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    If you have not already, join the eBay Developers Program. On the eBay Developers Program dashboard, navigate to **My Account** > **Application Access Keys**.

    1. Copy down the values for **App ID**, **DevID**, and **Cert ID**.
    2. Click **Get a User Token Here** to generate an access token. Set the Redirect URI to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)* and copy down your token.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the App ID you obtained from the Application Access Keys page.
        * **OAuth Client Secret**—the Cert ID you obtained from the Application Access Keys page.
        * **Ru Name**—(optional) the Redirect URL name used for validation. This property is only needed if you are using the provider to allow other users to access their own data.
        * **Use Sandbox**—set only if you are using a sandbox account.
        * **Site ID**—the Id of the eBay site that you want to connect to. The default value of 0 is for eBay U.S.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AuthNAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **Dev ID**—the DevID you obtained from the Application Access Keys page.
        * **OAuth Client Id**—the App ID you obtained from the Application Access Keys page.
        * **OAuth Client Secret**—the Cert ID you obtained from the Application Access Keys page.
        * **OAuth Access Token**—the access token you generated above.
        * **Ru Name**—(optional) the Redirect URL name used for validation. This property is only needed if you are using the provider to allow other users to access their own data.
        * **Use Sandbox**—set only if you are using a sandbox account.
        * **Site ID**—the Id of the eBay site that you want to connect to. The default value of 0 is for eBay U.S.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and eBay, see [this information page](https://cdn.cdata.com/help/BEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# eBay Analytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/EbayAnalytics-Embedded



## Prerequisites

Before you connect eBay Analytics to Connect AI, you must join the eBay Developers Program and create an application to obtain OAuth credentials.

<Steps>
  <Step>
    If you have not already done so, join the [eBay Developers Program](https://developer.ebay.com/).
  </Step>

  <Step>
    On the eBay Developers Program dashboard, navigate to **My Account** > **Application Access Keys**.
  </Step>

  <Step>
    On the **Application Keys** page, create an OAuth application and request credentials for either the **Production** or **Sandbox** environment, depending on whether you need access to real store data or a testing environment.
  </Step>

  <Step>
    Copy down the values for **App ID (Client ID)** and **Cert ID (Client Secret)**.
  </Step>

  <Step>
    Next to your App ID, click **User Tokens**, then select **Get a Token from eBay via Your Application**. Make sure **OAuth enabled** is selected.
  </Step>

  <Step>
    Configure a Redirect URL (RuName) for your application. Set the accepted URL to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)* and copy down the **RuName** value generated by eBay.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect eBay Analytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *eBay Analytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Ru Name**, which is the Redirect URL name used for validation (obtained in the prerequisites).
  </Step>

  <Step>
    (Optional) Select a **Marketplace Id** for the eBay Marketplace you want to connect to. Supported values are `DEFAULT`, `EBAY_AU`, `EBAY_CA`, `EBAY_FR`, `EBAY_DE`, `EBAY_GB`, `EBAY_IT`, `EBAY_ES`, and `EBAY_US`. The default value is `DEFAULT`.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the App ID you obtained from the **Application Access Keys** page.
        * **OAuth Client Secret**—the Cert ID you obtained from the **Application Access Keys** page.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the eBay sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your eBay account and grant the requested permissions.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the App ID you obtained from the **Application Access Keys** page in Ebay Analytics.
        * **OAuth Client Secret**—the Cert ID you obtained from the **Application Access Keys** page in Ebay Analytics.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and eBay Analytics, see [this information page](https://cdn.cdata.com/help/JJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Elasticsearch
Source: https://docs.cloud.cdata.com/en/Data-Sources/Elasticsearch-Embedded



## Prerequisites

In Elasticsearch, add the Connect AI static IP addresses to your connection whitelist.

## Setup Guide

Follow these steps to connect Elasticsearch to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Elasticsearch* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the REST **Server**'s host name or IP address.
  </Step>

  <Step>
    Enter the port for connecting to the Elasticsearch server.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="BASIC">
    <Steps>
      <Step>
        Enter the Elasticsearch username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWS RootKeys">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Region** where the ElasticSearch instance is hosted.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        Enter the **AWS Region** where the ElasticSearch instance is hosted.
      </Step>

      <Step>
        (Optional) If emulating a different role, enter it into the **AWS External Id** field.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="API Key">
    <Steps>
      <Step>
        Enter the **API Key** received from ElasticSearch.
      </Step>

      <Step>
        Enter the **API Key Id** returned alongside the above API Key.
      </Step>

      <Step>
        Select the **Data Model** from the drop down.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Elasticsearch, see [this information page](https://cdn.cdata.com/help/EEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Email
Source: https://docs.cloud.cdata.com/en/Data-Sources/Email-Embedded



## Setup Guide

Follow these steps to connect email to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Email* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **User**, which is the user of the email account used to authenticate.
  </Step>

  <Step>
    Enter the **Password** of the email account used to authenticate.
  </Step>

  <Step>
    Enter the **Server**, which is the name or address of the mail server.
  </Step>

  <Step>
    Select the **Protocol** that matches the type of email server you are connecting to: **IMAP** or **POP**. The default value is **IMAP**.
  </Step>

  <Step>
    (Optional) Enter the **Port** of the mail server. The default value is *143* for IMAP and *110* for POP.
  </Step>

  <Step>
    (Optional) Select an **SSL Mode** to specify the authentication mechanism used when connecting to the email server. Supported values are **AUTO**, **NONE**, **IMPLICIT**, and **EXPLICIT**. The default value is **NONE**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and email, see [this information page](https://cdn.cdata.com/help/REM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# EnterpriseDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/EnterpriseDB-Embedded



## Setup Guide

Follow these steps to connect EnterpriseDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *EnterpriseDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **User** field, enter the EnterpriseDB username for authentication.
  </Step>

  <Step>
    In the **Password** field, enter the password to authenticate with the EnterpriseDB server.
  </Step>

  <Step>
    (Optional) In the **Server** field, enter the host name or IP address of the EnterpriseDB Postgres Advanced Server.
  </Step>

  <Step>
    (Optional) In the **Database** field, enter the name of the EnterpriseDB database to connect to. If a database is not provided, the user's default database is used.
  </Step>

  <Step>
    (Optional) In the **Port** field, enter the port for connecting to the EnterpriseDB server. The default port is *5444*.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and EnterpriseDB, see [this information page](https://cdn.cdata.com/help/JEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Epicor Kinetic
Source: https://docs.cloud.cdata.com/en/Data-Sources/EpicorERP-Embedded



## Setup Guide

Follow these steps to connect Epicor Kinetic to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Epicor Kinetic* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **URL**—the base URL of the server hosting your Epicor Kinetic instance, without a trailing path (for example, *[https://example123.developer.epicor.com](https://example123.developer.epicor.com)*). Contact your Epicor administrator if you do not know this value.
    * **ERP Instance**—the name of your ERP company instance. This value appears as the first path segment in your Epicor Kinetic URL. For example, in [https://example123.developer.epicor.com/EPIC06/](https://example123.developer.epicor.com/EPIC06/), the ERP instance is *EPIC06*. Contact your Epicor administrator if you are unsure.
    * **Service**—the fully qualified name of the service you want to retrieve data from. For example, *erp.bo.CustomerSvc*, *erp.bo.GLAccountSvc*, *erp.bo.SalesOrderSvc*, *erp.bo.JournalEntrySvc*, or *BAQsvc*.

    <Tip>
      To discover the services available on your instance, append `/api/help` to your instance URL. For example, `https://{instance_id}.developer.epicor.com/{instance}/api/help`. For a complete reference, see the [Epicor REST Services Guide](https://epicweb.epicor.com/doc/Docs/Kinetic_RESTServicesGuideV2_2023.1.pdf).
    </Tip>
  </Step>

  <Step>
    Choose an **Auth Scheme** from the list.
  </Step>

  <Step>
    If you choose **Basic**, enter the following information:

    * **User**—the Epicor Kinetic username for authentication
    * **Password**—the user password
  </Step>

  <Step>
    If you choose **AzureADOpenID**, enter the **Azure Tenant**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Epicor Kinetic, see [this information page](https://cdn.cdata.com/help/UEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Exact Online
Source: https://docs.cloud.cdata.com/en/Data-Sources/ExactOnline-Embedded



<Note>
  You cannot sign in to Exact Online with embedded credentials. Please create a custom OAuth application to sign in instead. See below.
</Note>

## Prerequisites

Before connecting Exact Online to Connect AI, you must create a custom OAuth application in the Exact Online App Center:

<Steps>
  <Step>
    If you have not already done so, create an Exact Online developer account.
  </Step>

  <Step>
    Log in to the App Center.
  </Step>

  <Step>
    Navigate to **Manage Apps** > **Add a New Application**.
  </Step>

  <Step>
    Enter a name for the application.
  </Step>

  <Step>
    Set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Edit**. The App Center displays your new application's client ID and client secret. Save this information.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Exact Online to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Exact Online* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a region in the **Region** drop-down list that is associated with your Exact Online administration.
  </Step>

  <Step>
    On the **Advanced Settings** tab, enter the **OAuthClientId** and **OAuthClientSecret** values from the custom OAuth application you created in the Prerequisites section.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Exact Online sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Exact Online account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    The **Division** field populates with the divisions associated with your Exact Online administration. Select a division from the drop-down list. The default value is the first division in the list.
  </Step>

  <SaveAndTest title="Exact Online" />
</Steps>

## More Information

For more information about interactions between Connect AI and Exact Online, see [this information page](https://cdn.cdata.com/help/DYM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Excel for the web
Source: https://docs.cloud.cdata.com/en/Data-Sources/ExcelOnline-Embedded



## Setup Guide

Follow these steps to connect Excel for the web to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Excel for the web* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Sharepoint URL** to connect to Excel files on a SharePoint site. Leave this field blank to connect to Excel files on your OneDrive.
      </Step>

      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Excel for the web sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Excel for the web account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter the **OAuth Client Id**, which is the client Id assigned when you register your Excel for the web account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Excel for the web account.
      </Step>

      <Step>
        Enter the **Sharepoint URL** field to connect to Excel files on a SharePoint site. Leave blank to connect to Excel files on your OneDrive.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter the **OAuth Client Id**, which is the client Id assigned when you register your Excel for the web account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert** for your Excel for the web account in the format shown.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert Password** for your Excel for the web account, if required.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert Subject** for your Excel for the web account. This is the subject of the OAuth JWT certificate. If omitted, the first certificate in the certificate store is used.
      </Step>

      <Step>
        Enter the **Sharepoint URL** field to connect to Excel files on a SharePoint site. Leave blank to connect to Excel files on your OneDrive.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Issue Queries

In some configurations of Excel for the web, tables are accessible under the schema name OneDrive instead of ExcelOnline. For example, when querying a Excel for the web table, the fully-qualified table name might be `[ExcelOnline1].[OneDrive].[TableName]`. You can use [Data Explorer](/en/Data-Explorer) to view your schemas to see if this applies to your configuration.

## More Information

For more information about interactions between Connect AI and Excel for the web, see [this information page](https://cdn.cdata.com/help/FXM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Excel Services
Source: https://docs.cloud.cdata.com/en/Data-Sources/ExcelServices-Embedded



## Setup Guide

Follow these steps to connect Excel Services to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Excel Services* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** for the SharePoint site or site collection the provider connects to, for example, *[http://server/SharePoint/](http://server/SharePoint/)*.
  </Step>

  <Step>
    Enter the **File** name of the Excel file to connect to, including the `.xlsx` extension.
  </Step>

  <Step>
    Select the **Share Point Version** that matches the SharePoint server you are connecting to. Supported values are **SharePoint 2013** and **SharePoint 2010**. The default value is **SharePoint 2013**.
  </Step>

  <Step>
    (Optional) Enter the **Folder** path within the document library where the file specified in the **File** field is located.
  </Step>

  <Step>
    (Optional) Enter the **Library** name of the SharePoint document library that contains the Excel file you want to connect to. The Shared Documents library is used by default.
  </Step>

  <Step>
    (Optional) Set **Use RESTAPI** to specify whether the provider uses the SharePoint REST API instead of the OData API to retrieve data. The default value is **True**.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="NTLM">
    <Steps>
      <Step>
        Enter the **User** name for the account used to authenticate to the SharePoint server.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User** name for the account used to authenticate to the SharePoint server.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Digest">
    <Steps>
      <Step>
        Enter the **User** name for the account used to authenticate to the SharePoint server.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Forms">
    <Steps>
      <Step>
        Enter the **User** name for the account used to authenticate to the SharePoint server.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>No additional settings are required for this authentication method.</Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    <Steps>
      <Step>
        Enter the **User** name for the account used to authenticate to the SharePoint server.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** name used to authenticate.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **STSURL**, the URL of the security token service (STS) used for single sign-on (SSO) with ADFS.
      </Step>

      <Step>
        Enter the **SSO Login URL** for the identity provider.
      </Step>

      <Step>
        Enter the **SSO Domain** associated with the user account.
      </Step>

      <Step>
        (Optional) Enter the **SSO Properties** required to connect to the identity provider, formatted as a semicolon-separated list (for example, `SSOProperty1=value1;SSOProperty2=value2;`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Excel Services, see [this information page](https://cdn.cdata.com/help/DTM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Exchange
Source: https://docs.cloud.cdata.com/en/Data-Sources/Exchange-Embedded



## Setup Guide

Follow these steps to connect Exchange to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Exchange* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Specify the Exchange **Schema** to connect to. MSGraph is the recommended schema for Exchange.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Exchange sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Exchange account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter the **Azure Tenant** Id being used to access data. This value is the directory Id in the **Azure Portal** > **Azure Active Directory** > **Properties**.
      </Step>

      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Exchange sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Exchange account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your application with an OAuth authorization server.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned when you registered your application with an OAuth authorization server.
      </Step>

      <Step>
        (Optional) Enter the **Azure Tenant** Id being used to access data. This value is the directory Id in the **Azure Portal** > **Azure Active Directory** > **Properties**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your Exchange account for OAuth.
        * **OAuth JWT Cert**—the contents of the public key you generated.
        * **OAuth JWT Cert Type**—the type of key store containing the OAuth JWT certificate.
        * **Azure Tenant**—(optional) the tenant Id used to access data. This value is the directory Id in the **Azure Portal** > **Azure Active Directory** > **Properties**.
        * **OAuth JWT Cert Subject**—(optional) the subject of the OAuth JWT certificate. The default value is the first certificate in the certificate store.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Exchange, see [this information page](https://cdn.cdata.com/help/CEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# FHIR
Source: https://docs.cloud.cdata.com/en/Data-Sources/FHIR-Embedded



## Setup Guide

Follow these steps to connect FHIR to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *FHIR* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set your **Connection Type**. The connection type determines the authentication method you will use.
  </Step>
</Steps>

## Generic Authentication Methods

<Tabs>
  <Tab title="GenericOAuth">
    The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the Id assigned when you registered your FHIR account.
        * **OAuth Client Secret**—the client secret for your FHIR account.
        * **OAuth Authorization URL**—the URL where the user logs into OAuth and grants permissions to the application.
        * **OAuth Access Token URL**—the URL where authorization tokens can be exchanged for access tokens.
        * **URL**—the URL of the FHIR server. A sample generic URL is as follows: `http://my_fhir_server/r4b/`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the FHIR sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your FHIR account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>
        Enter the **URL** for your connection. A sample generic URL is as follows: `http://my_fhir_server/r4b/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Azure Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the URL of the FHIR server. A sample Azure URL is as follows: `https://MY_AZURE_FHIR.azurehealthcareapis.com/`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the FHIR sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your FHIR account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the Id assigned when you registered your FHIR account.
        * **OAuth Client Secret**—the client secret for your FHIR account.
        * **URL**—the URL of the FHIR server. A sample Azure URL is as follows: `https://MY_AZURE_FHIR.azurehealthcareapis.com/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## AWS Authentication Methods

Enter an **AWS Region**, and then select an **Auth Scheme**.

<Tabs>
  <Tab title="AwsRootKeys">
    <Steps>
      <Step>
        Enter the following information:

        * **AWS Access Key**—your AWS account access key. This value is found in your AWS security credentials page.
        * **AWS Secret Key**—your AWS account secret key. This value is found in your AWS security credentials page.
        * **URL**—the URL of the FHIR server. A sample AWS URL is as follows: `https://healthlake.REGION.amazonaws.com/datastore/DATASTORE_ID/r4/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AwsIAMRoles">
    <Steps>
      <Step>
        Enter the following information:

        * **AWS Access Key**—your AWS account access key. This value is found in your AWS security credentials page.
        * **AWS Secret Key**—your AWS account secret key. This value is found in your AWS security credentials page.
        * **AWS Role ARN**—the Amazon Resource Name of the role you want to use when authenticating.
        * **URL**—the URL of the FHIR server. A sample AWS URL is as follows: `https://healthlake.REGION.amazonaws.com/datastore/DATASTORE_ID/r4/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Google Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **URL** of the FHIR server. A sample Google URL is as follows: `https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/`.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the FHIR sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your FHIR account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth JWT Cert**—the contents of the certificate file provided by Google. A sample format is provided.
        * **OAuth JWT Subject**—(optional) the email address of the user whose data you want to access. Only set this value if the service account is part of a GSuite domain and you want to enable delegation.
        * **URL**—the URL of the FHIR server. A sample Google URL is as follows: `https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID/fhir/`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## InterSystems Authentication Methods

<Tabs>
  <Tab title="ApiKey">
    <Steps>
      <Step>
        Enter the **API Key** for your FHIR account.
      </Step>

      <Step>
        Enter the **URL** of the FHIR server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>
        Enter the **URL** of the FHIR server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and FHIR, see [this information page](https://cdn.cdata.com/help/KIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# FTP
Source: https://docs.cloud.cdata.com/en/Data-Sources/FTP-Embedded



## Setup Guide

Follow these steps to connect FTP to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *FTP* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Remote Host**, which is the hostname or IP address of the FTP server.
  </Step>

  <Step>
    Enter the **User**, which is the username for authenticating to the FTP server.
  </Step>

  <Step>
    Enter the **Password** for the FTP user account.
  </Step>

  <Step>
    (Optional) Enter the **Remote Port**, which is the network port used to connect to the FTP server.
  </Step>

  <Step>
    (Optional) Enter the **Remote Path**, which is the working directory path on the FTP server.
  </Step>

  <Step>
    (Optional) Select an **SSL Mode** to specify the SSL/TLS negotiation mode used when connecting to the FTP server. Supported values are **AUTOMATIC**, **NONE**, **IMPLICIT**, and **EXPLICIT**. The default value is **AUTOMATIC**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Facebook
Source: https://docs.cloud.cdata.com/en/Data-Sources/Facebook-Embedded



## Setup Guide

Follow these steps to connect Facebook to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Facebook* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) If you need to access data provided by an earlier **Version** of the Facebook API, enter it here.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Facebook sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Facebook account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Facebook, see [this information page](https://cdn.cdata.com/help/RBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Facebook Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/FacebookAds-Embedded



## Setup Guide

Follow these steps to connect Facebook Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Facebook Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Facebook Ads sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Facebook Ads account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    The **Account Id** field populates with your account Ids. Select an account Id from the drop-down list. The default value is the first account Id.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Facebook Ads, see [this information page](https://cdn.cdata.com/help/HRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Freshdesk
Source: https://docs.cloud.cdata.com/en/Data-Sources/FreshDesk-Embedded



## Setup Guide

Follow these steps to connect Freshdesk to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Freshdesk* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Domain** for your Freshdesk account. When you are logged into Freshdesk, the domain is displayed in the URL as `https://[domainValue].freshdesk.com`.
  </Step>

  <Step>
    Enter the **API Key** associated with your Freshdesk account. To obtain this, log in to your support portal and open your profile settings page. The API key appears below the **Change Password** section.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Freshdesk, see [this information page](https://cdn.cdata.com/help/GFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# GMO MakeShop
Source: https://docs.cloud.cdata.com/en/Data-Sources/GMOMakeShop-Embedded



## Setup Guide

Follow these steps to connect GMO MakeShop to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *GMO MakeShop* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Members Access Code, Products Access Code, Orders Access Code**—the access codes from your GMO MakeShop store account to access the orders API
    * **Shop Id**—the store account Id of your GMO MakeShop store
    * **Member Authentication Code**—the authentication code from your GMO MakeShop store account to access the MemberAuthenticationConfirm stored procedure
    * **Password**—the password for your GMO MakeShop account
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and GMO MakeShop, see [this information page](https://cdn.cdata.com/help/SMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Garoon
Source: https://docs.cloud.cdata.com/en/Data-Sources/Garoon-Embedded



## Setup Guide

Follow these steps to connect Garoon to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Garoon* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **URL**—the URL for your Garoon account. Here are accepted URL format for supported versions:
      * Cloud version : https\://(subdomain).cybozu.com (default)
      * Package version (Windows environment) : http\://(server IP address or host name)/scripts/(installation identifier)/grn.exe
      * Package version (Linux environment) : http\://(server IP address or host name)/cgi-bin/(installation identifier)/grn.cgi
    * **User**—the user Id of the authenticating Garoon user account.
    * **Password**—the password of the authenticating Garoon user account.
    * **Basic Auth User**—the additional username required for domains using basic authentication.
    * **Basic Auth Password**—the additional password required for domains using basic authentication.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Garoon, see [this information page](https://cdn.cdata.com/help/URM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# GitHub
Source: https://docs.cloud.cdata.com/en/Data-Sources/GitHub-Embedded



## Setup Guide

Follow these steps to connect GitHub to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *GitHub* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        (Optional) To restrict repositories and projects to a specific owner, enter the **Owner Login**. This is either the user name for an individual account or a login name associated with an organization account.
      </Step>

      <Step>
        Enter the base **URL** for the GitHub environment you are connecting to. This is required if connecting to a GitHub Enterprise Server instance or a GitHub Enterprise Cloud environment that uses a non-standard API domain. For connections to the standard GitHub service (including GitHub Enterprise Cloud accounts using the default API endpoint), this property must be left empty.
      </Step>

      <Step>
        (Optional) To restrict access to a certain schema, enter the **Schema** that the user has access to. By default, the user has access to all schemas.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the GitHub sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your GitHub account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PersonalAccessToken">
    <Steps>
      <Step>
        Enter your GitHub Personal Access Token in the **Token** field.

        To obtain a token, log in to your GitHub account, navigate to **Settings** > **Developer settings** > **Personal access tokens**, and click **Generate new token**. Select the required scopes and click **Generate token**. Copy and save the generated token, as it will only be shown once.
      </Step>

      <Step>
        (Optional) To restrict repositories and projects to a specific owner, enter the **Owner Login**. This is either the user name for an individual account or a login name associated with an organization account.
      </Step>

      <Step>
        Enter the base **URL** for the GitHub environment you are connecting to. This is required if connecting to a GitHub Enterprise Server instance or a GitHub Enterprise Cloud environment that uses a non-standard API domain. For connections to the standard GitHub service (including GitHub Enterprise Cloud accounts using the default API endpoint), this property must be left empty.
      </Step>

      <Step>
        (Optional) To restrict access to a certain schema, enter the **Schema** that the user has access to. By default, the user has access to all schemas.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and GitHub, see [this information page](https://cdn.cdata.com/help/FGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Gmail
Source: https://docs.cloud.cdata.com/en/Data-Sources/Gmail-Embedded



## Setup Guide

Follow these steps to connect Gmail to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Gmail* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Confirm your **Schema** in the drop down.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Gmail account.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Gmail account.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Gmail sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Gmail account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJwt">
    <Steps>
      <Step>
        Enter your **OAuth JWT Cert**. This is a multi-line key.
      </Step>

      <Step>
        Enter your **OAuth JWT Subject**. This must be set to the email address of the user whose data you want to access. The account must also be part of a GSuite domain.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Gmail, see [this information page](https://cdn.cdata.com/help/DLM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleAds-Embedded



## Setup Guide

Follow these steps to connect Google Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the developer token for your Google Ads account in the **Developer Token** field. If you do not have a developer token, see [this article](https://developers.google.com/google-ads/api/first-call/dev-token) for instructions.
  </Step>

  <Step>
    Enter your **Client Customer Id**. You can find this at the bottom of the help menu in the Google Ads UI.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Ads sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Ads account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT Cert**. This is a multi-line key.
      </Step>

      <Step>
        Enter your **OAuth JWT Subject**. This must be set to the email address of the user whose data you want to access. The account must also be part of a GSuite domain.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Ads, see [this information page](https://cdn.cdata.com/help/DZM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Ad Manager
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleAdsManager-Embedded



## Setup Guide

Follow these steps to connect Google Ad Manager to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Ad Manager* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Choose an **Auth Scheme** and continue with the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **Network Code**—this value appears in the URL after you log in to the network. For example, in the URL `https://www.google.com/dfp/1234567#delivery`, 1234567 is your network code.
        * **Version**—the latest Google Ad Manager Api version
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Ad Manager sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Ad Manager account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **Network Code**—this value appears in the URL after you log in to the network. For example, in the URL `https://www.google.com/dfp/1234567#delivery`, 1234567 is your network code.
        * **Version**—the latest Google Ad Manager Api version
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Ad Manager, see [this information page](https://cdn.cdata.com/help/BDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Analytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleAnalytics-Embedded



## Setup Guide

Follow these steps to connect Google Analytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Analytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Select your **Schema**. The options are `GoogleAnalytics4` or `UniversalAnalytics`.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Analytics sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Analytics account.
      </Step>

      <Step>
        Click **Continue** to grant the requested permissions.

        <Note>
          Each permission is required for the connection to function.
        </Note>
      </Step>

      <Step>
        If you selected `GoogleAnalytics4` as the schema, the **Property Id** field populates with your property Ids. Select a property Id from the drop-down list. The default value is the first property Id. You can also enter a custom value.
      </Step>

      <Step>
        If you selected `UniversalAnalytics` as the schema, enter your **Profile** and select your **API version**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT Cert**. This is a multi-line key in the format shown.
      </Step>

      <Step>
        Enter your **OAuth JWT Subject**. This must be set to the email address of the user whose data you want to access. The account must also be part of a GSuite domain.
      </Step>

      <Step>
        Select your **Schema**. The options are `GoogleAnalytics4` and `UniversalAnalytics`.
      </Step>

      <Step>
        (Optional) In the **Property Id** field, enter the Google Analytics profile that you want to use. If you leave this field blank, the connection uses the first returned profile.
      </Step>

      <Step>
        If you selected `GoogleAnalytics4` as the schema, enter the **Property Id**.
      </Step>

      <Step>
        If you selected `UniversalAnalytics` as the schema, enter your **Profile** and select your **API version**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Analytics, see [this information page](https://cdn.cdata.com/help/DAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Campaign Manager
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleCM-Embedded



## Setup Guide

Follow these steps to connect Google Campaign Manager to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Campaign Manager* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        In the **Profile Id** field of the **Authentication** section, enter the DoubleClick User Profile ID to connect to. If you do not specify a Profile ID, the first user profile returned is used.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Campaign Manager sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Campaign Manager account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        In the **Profile Id** field of the **Authentication** section, enter the DoubleClick User Profile ID to connect to. If you do not specify a Profile ID, the first user profile returned is used.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Campaign Manager, see [this information page](https://cdn.cdata.com/help/EPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Calendar
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleCalendar-Embedded



## Setup Guide

Follow these steps to connect Google Calendar to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Calendar* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Calendar sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Calendar account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth JWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT Cert**. This is multi-line and in PEM format.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**.
      </Step>

      <Step>
        (Optional) Enter an **OAuth JWT Cert Password**. This only needs to be done if the certificate is encrypted.
      </Step>

      <Step>
        (Optional) If required, add an **OAuth JWT Cert Subject**.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Issuer**. This must include the client\_id or connected app for the which the certificate is registered.
      </Step>

      <Step>
        (Optional) Enter an **OAuth JWT Subject**. It must be formatted as an email address.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Calendar, see [this information page](https://cdn.cdata.com/help/EGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Cloud Storage
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleCloudStorage-Embedded



## Setup Guide

Follow these steps to connect Google Cloud Storage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Cloud Storage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **Project Id** field, enter the Id of the project where your Google Cloud Storage instance resides. To find this value, open the Google Cloud Console and click the project name in the upper-left corner. The project Id appears in the **ID** column of the matching project.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Cloud Storage sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Cloud Storage account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth JWT">
    <Steps>
      <Step>
        This authentication method requires no additional fields.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWS Workload Identity">
    <Steps>
      <Step>
        Enter the **AWS Workload Identity Config**, the configuration properties to provide when using Workload Identity Federation via AWS.
      </Step>

      <Step>
        Enter the **Workload Pool Id**, the Id of your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Project Id**, the Id of the Google Cloud project that hosts your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Provider Id**, the Id of your Workload Identity Federation pool provider.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Azure Workload Identity">
    <Steps>
      <Step>
        Enter the **Azure Workload Identity Config**, the configuration properties to provide when using Workload Identity Federation via Azure.
      </Step>

      <Step>
        Enter the **Workload Pool Id**, the Id of your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Project Id**, the Id of the Google Cloud project that hosts your Workload Identity Federation pool.
      </Step>

      <Step>
        Enter the **Workload Provider Id**, the Id of your Workload Identity Federation pool provider.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Cloud Storage, see [this information page](https://cdn.cdata.com/help/HPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Contacts
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleContacts-Embedded



## Setup Guide

Follow these steps to connect Google Contacts to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Contacts* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Contacts sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Contacts account.
      </Step>

      <Step>
        Select the checkboxes next to each permission category and click **Continue** to grant the requested permissions.

        <Note>
          Each permission is required for the connection to function.
        </Note>
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information.

        * **OAuth JWT Cert**—Enter the content of the JSON certificate provided by Google.
        * (Optional) **OAuth JWT Subject**—Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Contacts, see [this information page](https://cdn.cdata.com/help/ECM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Directory
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleDirectory-Embedded



## Setup Guide

Follow these steps to connect Google Directory to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Directory* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Directory sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Directory account.
      </Step>

      <Step>
        Select the checkboxes next to each permission category and click **Continue** to grant the requested permissions.

        <Note>
          Each permission is required for the connection to function.
        </Note>
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Directory, see [this information page](https://cdn.cdata.com/help/EUM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Drive
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleDrive-Embedded



## Setup Guide

Follow these steps to connect Google Drive to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Drive* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Oauth">
    <Steps>
      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Drive sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Drive account.
      </Step>

      <Step>
        Click **Continue** to grant the requested permissions.

        <Note>
          Each permission is required for the connection to function.
        </Note>
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Oauth JWT">
    <Steps>
      <Step>
        Enter the **OAuth JWT Cert** provided by Google. This is a multi-line key.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Subject** if your services account is part of a GSuite domain and you want to enable delegation.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Drive, see [this information page](https://cdn.cdata.com/help/RGK/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Search
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleSearch-Embedded



## Setup Guide

Follow these steps to connect Google Search to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Search* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Custom Search Id**. You must sign into the Google Custom Search engine and create a new engine to obtain this Id.
  </Step>

  <Step>
    Enter the **API Key**. To obtain this you must enable the Custom Search API in the Google API Console.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Google Search, see [this information page](https://cdn.cdata.com/help/BLM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Sheets
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleSheets-Embedded



## Setup Guide

Follow these steps to connect Google Sheets to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Sheets* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Token">
    <Steps>
      <Step>
        Enter the **API Key** for your Google Cloud account. You can create an API key in the Google Cloud Console by clicking **Create credentials > API key**.
      </Step>

      <Step>
        (Optional) To improve performance, fill out either the **Spreadsheet** field with a comma separated list of sheet names or Ids or enter a **Folder Name**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        (Optional) To improve performance, fill out either the **Spreadsheet** field with a comma separated list of sheet names or Ids or enter a **Folder Name**.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Sheets sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Sheets account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the OAuth JWT Cert. This is multi-line and should be in the following format:

        ```json theme={null}
        {
          "type": "service_account",
          "project_id": "...",
          "private_key_id": "...",
          "private_key": "...",
          "client_email": "...",
          "client_id": "...",
          "auth_uri": ...",
          "token_uri": "...",
          "auth_provider_x509_cert_url": "...",
          "client_x509_cert_url": "..."
        }
        ```
      </Step>

      <Step>
        (optional) Set the **OAuthJWT Cert Subject**. Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.
      </Step>

      <Step>
        (Optional) To improve performance, fill out either the **Spreadsheet** field with a comma separated list of sheet names or Ids or enter a **Folder Name**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Sheets, see [this information page](https://cdn.cdata.com/help/RLM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Google Spanner
Source: https://docs.cloud.cdata.com/en/Data-Sources/GoogleSpanner-Embedded



## Setup Guide

Follow these steps to connect Google Spanner to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Google Spanner* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Database Dialect**. This is the dialect type of the connected database. The default value is correct for most connections.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **Project Id**—the ID of the project where your Google Spanner instance resides.
        * **Database**—the name of the database.
        * **Instance Id**—the ID of the Google Spanner instance to which you are connecting.
      </Step>

      <Step>
        Click **Sign in with Google** to connect securely through OAuth. This action opens the Google Spanner sign-in page on a new tab.
      </Step>

      <Step>
        Log in to your Google Spanner account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuthJWT Cert**—the content of the JSON certificate provided by Google.
        * **OAuthJWT Subject**—(optional) a subject value is required if the service account is part of a GSuite domain and you want to enable delegation.
        * **Project Id**—the ID of the project where your Google Spanner instance resides.
        * **Database**—the name of the database.
        * **Instance Id**—the ID of the Google Spanner instance to which you are connecting.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Google Spanner, see [this information page](https://cdn.cdata.com/help/OGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# GraphQL
Source: https://docs.cloud.cdata.com/en/Data-Sources/GraphQL-Embedded



## Setup Guide

Follow these steps to connect GraphQL to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *GraphQL* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of your GraphQL service.
  </Step>

  <Step>
    If you do not need authentication, select **None** in the **Auth Scheme** drop-down list. Otherwise, select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the GraphQL username for authentication into **User**.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your GraphQL account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your GraphQL account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Authorization URL** where the user logs into the service.
      </Step>

      <Step>
        Enter the **OAuth Access Token URL** where the request for the access token is made.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the GraphQL sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your GraphQL account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your GraphQL account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Authorization URL** where the user logs into the service.
      </Step>

      <Step>
        Enter the **OAuth Access Token URL** where the request for the access token is made.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and GraphQL, see [this information page](https://cdn.cdata.com/help/LAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Greenhouse
Source: https://docs.cloud.cdata.com/en/Data-Sources/Greenhouse-Embedded



## Setup Guide

Follow these steps to connect Greenhouse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Greenhouse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** for your Greenhouse account. To create an API key, follow the steps below.

    a. Click the **Configure** icon in the navigation bar and locate **Dev Center** on the left.

    b. Select **API Credential Management**.

    c. Click **Create New API Key**.
    d. Set "API Type" to **Harvest**.

    e. Set "Partner" to **custom**.

    f. Optionally, provide a description.

    g. Proceed to **Manage permissions** and select the appropriate permissions based on the resources you want to access through the driver.

    h. Copy and paste the created API Key.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Greenplum
Source: https://docs.cloud.cdata.com/en/Data-Sources/Greenplum-Embedded



## Setup Guide

Follow these steps to connect Greenplum to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Greenplum* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Password**—enter the user password.
    * **User**—enter the Greenplum username for authentication.
    * **Port**—enter the port for connecting to the Greenplum server. This is set to 5432 by default.
    * **Server**—enter the host name or IP address of the Greenplum server.
    * **Database**—(Optional) enter the name of the database to connect to. If left blank, the user's default database is used.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Greenplum, see [this information page](https://cdn.cdata.com/help/SGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# HDFS
Source: https://docs.cloud.cdata.com/en/Data-Sources/HDFS-Embedded



## Setup Guide

Follow these steps to connect HDFS to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *HDFS* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Host**, which specifies the host of your HDFS installation.
  </Step>

  <Step>
    Enter the **Port** of your HDFS installation. The default is 9870.
  </Step>

  <Step>
    (Optional) Enter the **Path**, which specifies the HDFS path used as the working directory.
  </Step>

  <Step>
    Select the **Auth Scheme** used for authentication, then proceed to the relevant section below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="None">
    <Steps>
      <Step>
        (Optional) Enter the **User**, which is the user name used to log in to the HDFS server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    <Steps>
      <Step>
        (Optional) Enter the **User**, which is the user name used to log in to the HDFS server.
      </Step>

      <Step>
        (Optional) Enter the **Password** used to authenticate to the HDFS server. This is only used when Kerberos authentication is selected.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the **Access Token**, which is the HDFS access token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and HDFS, see [this information page](https://cdn.cdata.com/help/GWM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Highrise
Source: https://docs.cloud.cdata.com/en/Data-Sources/Highrise-Embedded



## Setup Guide

Follow these steps to connect Highrise to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Highrise* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **AccountId** of the currently authenticated user.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth2">
    The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Highrise sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Highrise account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIToken">
    <Steps>
      <Step>
        Enter the **API Token** of the currently authenticated user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Highrise, see [this information page](https://cdn.cdata.com/help/BHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# HubDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/HubDB-Embedded



## Prerequisites

The **OAuth** authentication method requires a custom OAuth application created in HubSpot. If you are connecting with the **PrivateApp** method, you can skip this section.

To create a custom OAuth application, follow these steps:

<Steps>
  <Step>
    Sign in to your HubSpot developer account. If you do not have one, create a developer account at [developers.hubspot.com](https://developers.hubspot.com/).
  </Step>

  <Step>
    Navigate to **Apps** and click **Create app**.
  </Step>

  <Step>
    On the **Auth** tab, record the **Client ID** and **Client secret**. You enter these values as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>

  <Step>
    In the **Redirect URLs** field, enter the Connect AI callback URL `https://oauth.cdata.com/oauth/`.
  </Step>

  <Step>
    Under **Scopes**, add the scopes your application needs to access HubDB data, then save your application.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect HubDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *HubDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select your **Auth Scheme** and follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—Set to the client ID (also known as the consumer key) assigned to your custom OAuth application.
        * **OAuth Client Secret**—Set to the client secret assigned to your custom OAuth application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the HubDB sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your HubSpot account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PrivateApp">
    Enter your HubSpot Private App Token in the **Private App Token** field.

    You can generate a HubSpot Private App Token by following the steps below.

    <Steps>
      <Step>
        In your HubSpot account, click the **Settings** icon in the main navigation bar.
      </Step>

      <Step>
        In the left sidebar menu, navigate to **Integrations > Private Apps**.
      </Step>

      <Step>
        Click **Create private app**.
      </Step>

      <Step>
        On the **Basic Info** tab, configure the details of your application (name, logo, and description).
      </Step>

      <Step>
        On the **Scopes** tab, select **Read** or **Write** for each scope you want your private application to be able to access. This determines the data the connector has access to retrieve.
      </Step>

      <Step>
        After you are done configuring your application, click **Create app** in the top right. Review the information about your application's access token, click **Continue creating**, and then **Show token**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# HubSpot
Source: https://docs.cloud.cdata.com/en/Data-Sources/HubSpot-Embedded



## Setup Guide

Follow these steps to connect HubSpot to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *HubSpot* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select which **Schema** to connect to.
  </Step>

  <Step>
    If your **Schema** is **HubSpotV3**, you can choose to **Expand Associations** and/or **Include Custom Tables**. Note that in the **HubSpotV3** schema, certain tables are only accessible using the **PrivateAppToken** authentication method.
  </Step>

  <Step>
    Select your **Auth Scheme** and follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the HubSpot sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your HubSpot account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PrivateAppToken">
    Enter the Hubspot Private App Token in the **OAuth Access Token** field.

    You can generate a HubSpot Private App Token by following the steps below.

    <Steps>
      <Step>
        In your HubSpot account, click the **Settings** icon in the main navigation bar.
      </Step>

      <Step>
        In the left sidebar menu, navigate to **Integrations > Private Apps**.
      </Step>

      <Step>
        Click **Create private app**.
      </Step>

      <Step>
        On the **Basic Info** tab, configure the details of your application (name, logo, and description).
      </Step>

      <Step>
        On the **Scopes** tab, select **Read** or **Write** for each scope you want your private application to be able to access. This determines the data the driver has access to retrieve.
      </Step>

      <Step>
        After you are done configuring your application, click **Create app** in the top right. Review the information about your application's access token, click **Continue creating**, and then **Show token**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and HubSpot, see [this information page](https://cdn.cdata.com/help/DHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# IBM Cloud Object Storage
Source: https://docs.cloud.cdata.com/en/Data-Sources/IBMCloudObjectStorage-Embedded



## Setup Guide

Follow these steps to connect IBM Cloud Object Storage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *IBM Cloud Object Storage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication

<Steps>
  <Step>
    Enter the **Api Key**, which is used to identify the user to IBM Cloud. Create an API key by navigating to **Manage > Access (IAM) > Users** and clicking **Create**.
  </Step>

  <Step>
    (Optional) Enter the **Cloud Object Storage CRN**, which uniquely identifies your Cloud Object Storage instance in IBM Cloud (for example, *crn:v1:bluemix:public:cloud-object-storage:\[region\_id]:a/\[account\_id]:\[guid]*). To retrieve your **Cloud Object Storage CRN**, select your Cloud Object Storage instance from the Dashboard. Click the **Service credentials** tab on the right side and click **View credentials.**
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and IBM Cloud Object Storage, see [this information page](https://cdn.cdata.com/help/GMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# IBM Informix
Source: https://docs.cloud.cdata.com/en/Data-Sources/Informix-Embedded



## Setup Guide

Follow these steps to connect IBM Informix to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *IBM Informix* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme**. Choose EUSRIDPWD to authenticate with an encrypted user Id and password.
  </Step>

  <Step>
    Enter the following information:

    * **User**—the IBM Informix username for authentication
    * **Password**—the user password
    * **Database**—the name of the database to connect to
    * **Port**—the port for connecting to the IBM Informix server
    * **Server**—the host name or IP address of the IBM Informix server
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and IBM Informix, see [this information page](https://cdn.cdata.com/help/JIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Instagram
Source: https://docs.cloud.cdata.com/en/Data-Sources/Instagram-Embedded



## Prerequisites

If you choose to create a custom OAuth application in the Meta Developer Portal (optional), follow these steps:

<Note>
  Before you begin, make sure your Instagram account is a Business or Creator account that is connected to a Facebook Page. You must have a role on the Page that is associated with the Instagram account.
</Note>

<Steps>
  <Step>
    Go to the [Meta Developer Portal](https://developers.facebook.com/apps). Sign in with your Facebook account (or create one if you do not already have one).
  </Step>

  <Step>
    Register the application.

    * Click **Create App** and follow the prompts to create a new app.
    * After the app is created, go to **Settings** > **Basic**. The **App ID** and **App Secret** shown here are the values you will enter as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
    * Click **Add Platform** and select **Website**. Enter a **Site URL** for your application.
  </Step>

  <Step>
    Add and configure the Facebook Login product.

    * From the left navigation, click **Add Product** and add **Facebook Login**.
    * Under **Facebook Login** > **Settings**, in **Valid OAuth Redirect URIs**, enter the redirect URI used by Connect AI: *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
    * Save your changes.
  </Step>

  <Step>
    Add the Instagram product.

    * From the left navigation, click **Add Product** and add **Instagram**.
  </Step>

  <Step>
    Submit your app for review.

    * Click **App Review** > **Permissions and Features**, then click **Request Advanced Access** for the following permissions: **instagram\_basic**, **instagram\_manage\_comments**, and **instagram\_manage\_insights**.
    * Provide the information Meta requires and submit the request. You must wait for Meta to approve the permissions before you can use the custom OAuth app to connect production Instagram accounts.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Instagram to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Instagram* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) **Enter a Business Account Id**. This is only required if you have more than one Instagram business account associated with one Facebook Account.
  </Step>

  <Step>
    (Optional) If you are using a custom OAuth application to connect, click **Advanced Settings** and enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the prerequisites.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Instagram sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Instagram account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Instagram, see [this information page](https://cdn.cdata.com/help/ENM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Jira
Source: https://docs.cloud.cdata.com/en/Data-Sources/JIRA-Embedded



## Setup Guide

Follow these steps to connect Jira to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Jira* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** to your Jira endpoint.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Jira sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Jira account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIToken">
    <Steps>
      <Step>
        Enter the Jira username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the Jira **API token** for the username that you enter in the **User** field.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the Jira username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Crowd">
    <Steps>
      <Step>
        Enter the Jira username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Enter the **SSO Login URL** associated with the Crowd account. You can find the IDP URL by navigating to **your application > SSO > SSO information > Identity provider single sign-on URL**.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** used to exchange the SAML token for Jira cookies. This URL can have the following format: `https://<authority of Jira instance>/plugins/servlet/samlsso`.
      </Step>

      <Step>
        Enter the **SSO App Name** of the application.
      </Step>

      <Step>
        Enter the **SSO App Password** of the application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Jira username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        Enter all relevant property-value pairs into the **SSO Properties** field with the format `ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;`. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL** used to exchange the SAML token for Jira cookies. This URL can have the following format: `https://<authority of Jira instance>/plugins/servlet/samlsso`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="LDAP">
    <Steps>
      <Step>
        Enter the Jira username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Jira, see [this information page](https://cdn.cdata.com/help/BJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# JSON
Source: https://docs.cloud.cdata.com/en/Data-Sources/JSON-Embedded



## Setup Guide

Follow these steps to connect JSON to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *JSON* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI** for the JSON resource location.
  </Step>

  <Step>
    Select the **Data Model** to use when parsing JSON documents. Options are as follows:

    * **Document**–returns a single table representing a row for each top-level object.
    * **FlattenedDocuments**–returns a single table representing a JOIN of the available documents in the file.
    * **Relational**–returns multiple tables, one for each **JSON Path** value specified.
  </Step>

  <Step>
    (Optional) Enter the **JSON Path**, which is the JSONPath expression that defines which array elements are modeled as rows. For multiple paths, provide a semicolon-separated list. If left blank, object arrays in the JSON document are detected automatically and modeled as rows.
  </Step>

  <Step>
    (Optional) Select the **JSON Format** to use. Options are as follows:

    * **JSON**–the default format to be used in a majority of cases.
    * **JSONRows**–the data is returned in a relational format consisting of rows of data contained within primitive arrays.
    * **LDJSON (Line-Delimited JSON)**–used to parse line-delimited JSON files (also known as NDJSON or JSONLines).
  </Step>

  <Step>
    Select the **Connection Type**, which specifies the file storage service, server, or file access protocol through which your JSON files are stored and retrieved. Then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Connection Types

<Tabs>
  <Tab title="Amazon S3">
    <Steps>
      <Step>
        Select the **AWS Region** from the drop-down list. This is the hosting region for your Amazon Web Services.
      </Step>

      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme** to use when connecting to remote services. Then select the tab for your authentication scheme and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AwsRootKeys">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsEC2Roles">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsIAMRoles">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Role ARN**. This is the Amazon Resource Name of the role to use when authenticating.
          </Step>

          <Step>
            (Optional) Enter the **AWS External Id**. This is a unique identifier that might be required when you assume a role in another account.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsTempCredentials">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to AWS. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Session Token**. See the [AWS Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) for more information about the session token.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsCredentialsFile">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Keycloak">
        <Steps>
          <Step>
            Enter the **Keycloak Realm URL**. This specifies the full URL to the Keycloak server, including the specific realm used for authentication and authorization.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="EKSPodIdentity">
        <Steps>
          <Step>
            (Optional) Enter the **AWS Container Credentials Full URI**. This is the full URI of the container credential provider endpoint used by EKS Pod Identity.
          </Step>

          <Step>
            (Optional) Enter the **AWS Container Authorization Token File**. This is the path to a file containing the authorization token for the EKS Pod Identity credential provider.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Blob Storage">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2 SSL">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Files">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Box">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Dropbox">
    <Steps>
      <Step>
        (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
      </Step>

      <Step>
        (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
      </Step>

      <Step>
        (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTP">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTPS">
    <Steps>
      <Step>
        Enter the **User** that the provider needs to authenticate.
      </Step>

      <Step>
        Enter the **Password** used to authenticate the user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Google Cloud Storage">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Google Drive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="GCPInstanceAccount">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HDFS Secure">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Negotiate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTP">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="HTTPS">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Digest">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthJWT">
        <Steps>
          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Subject**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **OAuth JWT Subject Type** for the JWT authentication.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Public Key Id**.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPassword">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthClient">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **Subject Id**, which is the user subject for which the application is requesting delegated access.
          </Step>

          <Step>
            (Optional) Select the **Subject Type** for the client credentials authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OAuthPKCE">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="IBM Object Storage Source">
    <Steps>
      <Step>
        Enter the **Api Key** used to identify the user to the IBM Cloud.
      </Step>

      <Step>
        Enter the **Region**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="OAuth">
        <Steps>
          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from the security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to IBM Cloud. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key**. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneDrive">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="OneLake">
    <Steps>
      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Oracle Cloud Storage">
    <Steps>
      <Step>
        Enter the hosting **Region** for your S3-like Web Services.
      </Step>

      <Step>
        Enter the **Oracle Namespace**. This is the Oracle Cloud Object Storage namespace to use.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="IAMSecretKey">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="HMAC">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to Oracle Cloud Storage. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **Secret Key** of your account. This value is accessible from your security credentials page.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SFTP">
    <Steps>
      <Step>
        Select the **SSH Auth Mode**, which is the type of authentication to use when connecting to remote services. Then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="None">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Password">
        <Steps>
          <Step>
            Enter the **SSH User** used to authenticate to the SFTP server.
          </Step>

          <Step>
            Enter the **SSH Password** used to authenticate to the SFTP server.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Public_Key">
        <Steps>
          <Step>
            Enter the **SSH Client Cert**, which is the name of the certificate store for the client certificate.
          </Step>

          <Step>
            Select the **SSH Client Cert Type**, which is the type of key store containing the client certificate.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Password**. This is the password for the client certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **SSH Client Cert Subject**. This is the subject of the SSH client certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the JSON tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint SOAP">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="SharePoint REST V1">
    <Steps>
      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="Basic">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="NTLM">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="OneLogin">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider needs to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and JSON, see [this information page](https://cdn.cdata.com/help/DJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Jira Assets
Source: https://docs.cloud.cdata.com/en/Data-Sources/JiraAssets-Embedded



## Setup Guide

Follow these steps to connect Jira Assets to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Jira Assets* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** to your Jira Assets endpoint, for example, `https://yoursitename.atlassian.net`.
  </Step>

  <Step>
    Enter the Jira Assets username for authentication in the **User** field.
  </Step>

  <Step>
    Enter the Jira **API token** for the username that you entered in the **User** field. To create an API token:

    * Navigate to [the API Tokens page of your Atlassian account](https://id.atlassian.com/manage/api-tokens).
    * Click **Create API token**.
    * Name your API token and adjust the expiration date, if necessary.
    * Click **Create**.
    * Copy and paste the API token.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Jira Service Desk
Source: https://docs.cloud.cdata.com/en/Data-Sources/JiraServiceDesk-Embedded



## Setup Guide

Follow these steps to connect Jira Service Desk to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Jira Service Desk* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Jira Service Desk username for authentication.
        * **Password**—the user password.
        * **URL**—the URL to your Jira Service Desk endpoint (for example, `https://yoursitename.atlassian.net`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your Jira Service Desk account for OAuth.
        * **OAuth Client Secret**—the client secret assigned when you registered your Jira Service Desk account for OAuth.
        * **URL**—the URL to your Jira Service Desk endpoint (for example, `https://yoursitename.atlassian.net`).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Jira Service Desk sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Jira Service Desk account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIToken">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Jira Service Desk username for authentication.
        * **API Token**—to connect to a Connect AI account, you need to retrieve an API token. To generate one, log in to your Atlassian account and under **Security** settings, click **Create and manage API tokens** and then click **Create API token**.
        * **URL**—the URL to your Jira Service Desk endpoint (for example, `https://yoursitename.atlassian.net`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Crowd">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Jira Service Desk username for authentication.
        * **Password**—the user password.
        * **SSO Login URL**—the login URL associated with the Crowd account. You can find the IDP URL by navigating to **your application** > **SSO** > **SSO information** > **Identity provider single sign-on URL**.
        * **SSO Exchange URL**—the URL used to exchange the SAML token for Jira Service Desk cookies. This URL may have the following formats: `https://<authority of Jira Service Desk instance>/plugins/servlet/samlconsumer` or `https://<authority of Jira Service Desk instance>/plugins/servlet/samlsso`.
        * **SSO App Name**—the name of the application in which SSO is enabled.
        * **SSO App Password**—the password of the application in which SSO is enabled.
        * **URL**—the URL to your Jira Service Desk endpoint (for example, `https://yoursitename.atlassian.net`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the Jira Service Desk username for authentication.
        * **Password**—the user password.
        * **SSO Login URL**—the login URL associated with the Okta account. You can find the IDP URL by navigating to **your application** > **SSO** > **SSO information** > **Identity provider single sign-on URL**.
        * **SSO Properties**—enter all relevant properties with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
        * **SSO Exchange URL**—the URL used to exchange the SAML token for Jira Service Desk cookies. This URL may have the following formats: `https://<authority of Jira Service Desk instance>/plugins/servlet/samlconsumer` or `https://<authority of Jira Service Desk instance>/plugins/servlet/samlsso`.
        * **URL**—the URL to your Jira Service Desk endpoint (for example, `https://yoursitename.atlassian.net`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Jira Service Desk, see [this information page](https://cdn.cdata.com/help/GKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Kintone
Source: https://docs.cloud.cdata.com/en/Data-Sources/Kintone-Embedded



## Setup Guide

Follow these steps to connect Kintone to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Kintone* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the Kintone **URL** (for example, `https://*SubdomainName*.cybozu.com`)
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        In the **User** field, enter the Kintone username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="API Token">
    <Steps>
      <Step>
        In the **App Id** field, enter the application Id to use for authentication.
      </Step>

      <Step>
        In the **API Token** field, add the API token to use for authentication with the application Id. To generate an API token in Kintone, navigate to **App Settings tab > API Token** and click the **Generate** Button.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Kintone, see [this information page](https://cdn.cdata.com/help/EKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Klaviyo
Source: https://docs.cloud.cdata.com/en/Data-Sources/Klaviyo-Embedded



## Setup Guide

Follow these steps to connect Klaviyo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Klaviyo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    For **Schema**, enter the Klaviyo API Revision the provider uses on a connection. The default value is `Klaviyo20250415`.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="API Key">
    <Steps>
      <Step>
        Enter the **API Key** used for accessing your Klaviyo account. To generate the API Key:

        1. Log in to your user account.
        2. Navigate to the [Private API Key creation page](https://www.klaviyo.com/login?next=/settings/account/api-keys).
        3. Click **Create Private API Key**.
        4. Under **Private API Key Name**, assign a name to the key.
        5. Under **Select Access Level**, choose the required access level. At minimum, **Accounts: Read** access is required for a successful Test Connection.
        6. Click **Create** to generate the API Key. Copy and save the generated API Key, as it is only shown once.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        To authenticate using OAuthPKCE, you must first create a custom OAuth application. Then set the following properties:

        * **OAuthClientId**–enter the client Id (also known as the consumer key) assigned when you registered your app for OAuth.
        * **OAuthClientSecret**–enter the client secret assigned when you registered your app for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# LDAP
Source: https://docs.cloud.cdata.com/en/Data-Sources/LDAP-Embedded



## Setup Guide

Follow these steps to connect LDAP to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *LDAP* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In the **Server** field, enter the domain name or IP address of the LDAP server. Do not include the LDAP:// prefix; only include the server's domain name or IP address.
  </Step>

  <Step>
    Enter the **Port** on which the LDAP server is running. The default port is 389.
  </Step>

  <Step>
    In the **User** field, enter the distinguished name (DN) of the user account used for authentication with the LDAP server.
  </Step>

  <Step>
    Enter the **Password** associated with the distinguished name.
  </Step>

  <Step>
    Enter the **Base DN**. Specifying a base distinguished name limits the scope of searches and can increase performance, especially on large LDAP servers.
  </Step>

  <Step>
    (Optional) Set **Schema** to choose the version to connect with. The default is **Static**, which uses the hard-coded column values in the .rsd files. Set it to **Dynamic** to use the table and column information provided by Active Directory.
  </Step>

  <Step>
    (Optional) Enable **Use SSL** to secure the connection to the LDAP server with SSL encryption.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and LDAP, see [this information page](https://cdn.cdata.com/help/RJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Databricks Lakebase
Source: https://docs.cloud.cdata.com/en/Data-Sources/Lakebase-Embedded



## Prerequisites

To use the OAuthClient authentication method, you must create a service principal in Databricks Lakebase and assign permissions. Refer to the [Databricks documentation](https://docs.databricks.com/aws/en/admin/users-groups/manage-service-principals).

Next, the account or workspace administrator creates an OAuth secret:

<Steps>
  <Step>
    At the new service principal's details page, in the **Developer Service Principal** section, click the **Secrets** tab.
  </Step>

  <Step>
    Under OAuth secrets, click the **Generate secret** button.
  </Step>

  <Step>
    Enter the desired lifetime for the secret in days, up to a maximum of 730 days (two years). The admin console displays updated details about the new service principal, including the OAuth secret and the Client ID (which is the same as the service principal's application ID).
  </Step>

  <Step>
    Enter the Client Id and Secret in the fields below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Databricks Lakebase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Databricks Lakebase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the **Server** name hosting the Databricks Lakebase database.
  </Step>

  <Step>
    Enter the name of the target Databricks Lakebase **Database**.
  </Step>

  <Step>
    For **Databricks Instance**, enter the URL for the user interface during normal access of the Databricks console. This should be in the format of `dbc-(id).cloud.databricks.com`.
  </Step>

  <Step>
    Enter the **Port** number of the server hosting the Databricks Lakebase database. The default value is 5432.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the **OAuthClientId** assigned when you configured the service principal (in the prerequisites).
      </Step>

      <Step>
        Enter the **OAuthClientSecret** assigned when you configured the service principal (in the prerequisites). This value authenticates the application to the OAuth authorization server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Enter the **User** Id of the authenticating user. The user obtains a temporary code from the authorization server.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Lakebase, see [this information page](https://cdn.cdata.com/help/LSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Linear
Source: https://docs.cloud.cdata.com/en/Data-Sources/Linear-Embedded



## Setup Guide

Follow these steps to connect Linear to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Linear* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="APIKey">
    To use API key authentication, generate a personal API key in Linear:

    <Steps>
      <Step>
        Log in to your Linear account and go to **Settings** > **API** > **Personal API keys**.
      </Step>

      <Step>
        Click **Create key**.
      </Step>

      <Step>
        Enter a descriptive label for the key and click **Create**.
      </Step>

      <Step>
        Copy the generated key immediately and store it securely; it is only displayed once.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the key as the **API Key**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    To use OAuth authentication, register an OAuth application with Linear:

    <Steps>
      <Step>
        Log in to your Linear account and go to **Settings** > **API** > **OAuth Applications**.
      </Step>

      <Step>
        Click **New OAuth Application**.
      </Step>

      <Step>
        Enter a **Name** for the application.
      </Step>

      <Step>
        Set the **Callback URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Click **Create application**, then copy the **Client ID** and **Client Secret**. Store the secret securely.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Linear.
      </Step>

      <Step>
        Optionally, update the **Scope** field. The default value is `read,write`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Linear sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Linear account and grant the requested permissions.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    OAuthClient uses client credentials for machine-to-machine access without a user sign-in. Register an OAuth application with Linear:

    <Steps>
      <Step>
        Log in to your Linear account and go to **Settings** > **API** > **OAuth Applications**.
      </Step>

      <Step>
        Click **New OAuth Application**.
      </Step>

      <Step>
        Enter a **Name** for the application.
      </Step>

      <Step>
        Set the **Callback URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Click **Create application**, then copy the **Client ID** and **Client Secret**. Store the secret securely.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Linear.
      </Step>

      <Step>
        Optionally, update the **Scope** field. The default value is `read,write`.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# LinkedIn
Source: https://docs.cloud.cdata.com/en/Data-Sources/LinkedIn-Embedded



## Setup Guide

Follow these steps to connect LinkedIn to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *LinkedIn* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    (Optional) Enter your **Company Id**. This is the number that appears in the URL; for example, in the URL `www.linkedin.com/company/1337`, 1337 is the Company Id.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the LinkedIn sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your LinkedIn account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and LinkedIn, see [this information page](https://cdn.cdata.com/help/CLM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# LinkedIn Ads
Source: https://docs.cloud.cdata.com/en/Data-Sources/LinkedInAds-Embedded



## Setup Guide

Follow these steps to connect LinkedIn Ads to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *LinkedIn Ads* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the LinkedIn Ads sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your LinkedIn Ads account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and LinkedIn Ads, see [this information page](https://cdn.cdata.com/help/EBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MailChimp
Source: https://docs.cloud.cdata.com/en/Data-Sources/MailChimp-Embedded



## Setup Guide

Follow these steps to connect MailChimp to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MailChimp* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Log in to your MailChimp account from a separate browser window.
  </Step>

  <Step>
    Select **Account** > **Extras** > **API Keys**. Copy the API key value.
  </Step>

  <Step>
    Return to Connect AI.
  </Step>

  <Step>
    Enter the API key value from MailChimp in the **API Key** field.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MailChimp, see [this information page](https://cdn.cdata.com/help/CMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# CRM Analytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/TableauCRM-Embedded



## Setup Guide

Follow these steps to connect CRM Analytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *CRM Analytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the CRM Analytics sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your CRM Analytics account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuthJWT Cert**—the content of the certificate in PEM format.
        * **OAuthJWT Issuer**—the OAuth Client Id of the connected app for which you registered the certificate.
        * **OAuthJWT Cert Password**—(Optional) required if the certificate is encrypted.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and CRM Analytics, see [this information page](https://cdn.cdata.com/help/FSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# REST
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIConnector-Embedded

The REST Connector provides a fully customizable way to connect directly to a REST API. You can connect to proprietary endpoints, filter relevant columns, run queries, and manage user access.

Follow these steps to connect your REST API:

<Steps>
  <Step>
    Open the **Sources** page of the navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *REST* in the search field, then click the data source name.
  </Step>

  <Step>
    Connect and configure your REST API. The following tabs are available. Start with the global settings, then continue to create tables and set permissions. Click the links below to view detailed documentation.

    * [Global Settings](/en/Data-Sources/APIGlobalSettings-Embedded)—set global connection properties, authentication, headers, and pagination.
    * [Tables](/en/Data-Sources/APICreateTable-Embedded)—create tables, configure properties and filter columns.
    * [Permissions](/en/Data-Sources/APIPermissions)—manage user access.
  </Step>
</Steps>


# Tables
Source: https://docs.cloud.cdata.com/en/Data-Sources/APICreateTable-Embedded



## Summary

After connecting to your REST API, you can create, view, and configure the data from it in the form of tables. Tables can be customized via a wizard. You can also specify server-side filters to improve efficiency. This page covers creating tables and configuring table data, parameters, headers, and filters.

## Create Tables

When creating tables for [REST Connector](/en/Data-Sources/APIConnector-Embedded), it is important to remember that each table must be created individually in order to be listed in the Connector's catalog. To do so, follow the steps below:

<Steps>
  <Step>
    Click **Add** to begin creating a new table.
  </Step>

  <Step>
    Enter a **Name** for the table.
  </Step>

  <Step>
    In **Request URL**, choose either `Get` or `Post`.
  </Step>

  <Step>
    Enter the URL of your API endpoint into the **Request URL** field.
    <Note>To connect to an API that requires a different request for each record, include the name of the column in curly braces. For example, `https://api.example.com/table/{id}`.</Note>
  </Step>

  <Step>
    If you select `Post`, supply the **Body** to include in the API request. Then enter the `URL` of your API endpoint.

    <p>
      You can use the **Body** section to request body filters for `Post` API requests. The following is an example of a request body and a filter:

      ```
      {
      	"query": { "date_utc": { "$gte": "[_input.startDate]", "$lte": "[_input.endDate]" } }, "options": { "select": \["name", "date_utc", "success", "details"], "sort": { "date_utc": "asc" }, "limit": 20 } 
      }
      ```
    </p>

    In this case, the user is prompted to input a start date and an end date.

    <p>
      When you have a body filter, **Edit Table** displays the message **Body Filters Detected**.
    </p>

    <Note>
      If your table request body also contains filters, you must add an escape character to the square bracket, as shown in the example above before `"name"`.
    </Note>
  </Step>

  <Step>
    Select a **Response Type** of **JSON**, **LDJSON**, **XML**, or **CSV**.

    * **JSON**—the response is formatted as JSON.
    * **LDJSON**—the response is formatted as Linked Data JSON, which allows you to link definitions of objects within the JSON data.
    * **XML**—the response is formatted as XML-tagged data.
    * **CSV**—the response is formatted as comma-delimited data.
  </Step>
</Steps>

### Table Data

Next, you must tell the connector how to model the API's response into a table.

<Steps>
  <Step>
    Click **Configure** in the **Table Data** section to open the configuration wizard.
  </Step>

  <Step>
    (Optional) If you added a unique record identifier in the **Request URL**, such as `{id}`, a **Query Inputs** dialog appears. Set a value for the record identifier in order to retrieve the initial response data, and click **Next**.

    <Frame>
      <img alt="API query inputs" />
    </Frame>
  </Step>

  <Step>
    The connector calls your API and provides a preview of the data.

    <Frame>
      <img alt="REST Connector Table" />
    </Frame>
  </Step>

  <Step>
    Click **Next**.
  </Step>

  <Step>
    In the **Add Repeat Elements** dialog, select the checkbox next to the repeat elements you want added to your API table. This is the path of the element in your API endpoint which contains the repeating items to be used as rows. You can select multiple repeat elements if there are repeat elements within multiple paths in the response.

    <Frame>
      <img alt="API add repeat elements" />
    </Frame>
  </Step>

  <Step>
    (Optional) You can toggle **Custom Repeat Elements** to add repeat elements manually, rather than selecting from a list.

    <Frame>
      <img alt="API custom repeat elements" />
    </Frame>

    Click **Add Repeat Element** to add another repeat element manually.
  </Step>

  <Step>
    Click **Next**.
  </Step>

  <Step>
    In the **Add Columns** dialog, select the columns to add to your API table.

    <Frame>
      <img alt="API add columns" />
    </Frame>

    Once you have selected your columns, click **Next**.
  </Step>

  <Step>
    In the **Preview Table** dialog, review the table contents. Click **Back** to make any changes.

    <Frame>
      <img alt="API preview table" />
    </Frame>
  </Step>

  <Step>
    Review the preview of your table and click **Next**. The Configuration Wizard automatically imports all selected columns into the correct fields.
  </Step>

  <Step>
    Back in the **Table Data** section of the **Edit Table** screen, you can edit column names and data types. You can also assign primary keys or delete columns. In the case of child tables, you can also change the parent reference column. For other edits, click **Configure** again to adjust repeat elements and other data.
  </Step>

  <Step>
    In the **Pseudo Columns** tab, you can add columns to be used as filters in the WHERE clause of queries, but are not present in the data output.
  </Step>

  <Step>
    Click **Save** at the top of **Edit Table** screen to save the table data.
  </Step>

  <Step>
    Click **Preview** at the top of the **Edit Table** screen to preview your table. If you added a unique record identifier, a **Query Inputs** dialog appears. Set a value to preview the response data.
  </Step>
</Steps>

### Parameters

You can add URL parameters to be sent with all API requests for this table. To create a parameter:

<Steps>
  <Step>
    Click **Add Param**.
  </Step>

  <Step>
    Enter the parameter **Name**.
  </Step>

  <Step>
    Enter the parameter **Value**.
  </Step>
</Steps>

To add more parameters, repeat the steps above.

### Headers

You can add HTTP headers that are sent with all API requests for this table. These headers are in addition to the headers configured with the REST Connector itself. To add a new header:

<Steps>
  <Step>
    Enter the header **Name**.
  </Step>

  <Step>
    Specify the **Value** of the header.
  </Step>
</Steps>

To add more headers, click **Add Header** and repeat the steps above.

### Filters

After creating the table with columns, you can create filters to define the behavior of the REST Connector when a WHERE clause is issued during a query. Filters are optional, but can improve performance for WHERE clause conditions.

<Steps>
  <Step>
    Click **Add Filter**.
  </Step>

  <Step>
    Select the **Column Name** the filter applies to. This filter is applied when the selected column and SQL operator exist in the WHERE clause.
  </Step>

  <Step>
    Select an **SQL Operator**. This filter is applied when the selected column and SQL operator exist in the WHERE clause.
  </Step>

  <Step>
    Select a **Request Filter** from the drop-down list: **URL Parameter** or **Request Header**. The request filter determines how the filter is passed in the request to the API.
  </Step>

  <Step>
    Specify the **URL Parameter** or the **Request Header** that this API uses to filter.
  </Step>
</Steps>

To add more filters, repeat the steps above.

#### Example

This example shows how to create a filter that processes a query that filters records in the Reports table by the date the record was created.

Here is an example of such a query:

```sql theme={null}
SELECT * FROM Reports WHERE CreatedDate > '2022-12-31'
```

If no filter has been defined for this table, the connector processes this filter in memory by reading all of the rows from the API and filtering the list in memory by the specified `CreatedDate` column. However, this API supports this type of filtering on the server side which can improve performance substantially. This is what this query would look like to the API:

```bash theme={null}
https://www.mycustomapi.org/api/reports?$startdate=2022-12-31
```

In order to tell the connector how to send this filter to the API, you would specify the following fields:

**Column Name**: CreatedDate

**SQL Operator**: Greater Than

**Request Filter**: URL Parameter

**Parameter Name**: startdate

This instructs the connector that when a greater than operator has been specified for the `CreatedDate` column, include the `startDate` URL parameter with the filter value in the API request.


# Example REST Connector
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIExample-Embedded



## Summary

This page acts as an example of the steps required to configure a connection to an API from start to finish. This example uses an API that contains people's maintenance schedules for their vehicles.

## Create the REST Connection

First, create a new REST connection.

<Steps>
  <Step>
    Open the **Sources** page of the navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    In the **Add Connection** dialog that opens, type *REST* to display the REST Connector tile, then click the tile.
  </Step>

  <Step>
    On the **Global Settings Tab**, name the connection. This example uses "TestAPI."
  </Step>

  <Step>
    Select the Authentication method. Since no authentication is required for this API, select `No Auth`.
  </Step>

  <Step>
    Leave this section blank, because no headers are required for this connection.
  </Step>

  <Step>
    Set the pagination. This API uses a next page URL, providing the next page URL as part of the response. The following example shows the relevant part of the response from the Vehicles endpoint:

    ```json theme={null}
    {
      "people": [
        {
            ...
        },
        ...
      ],
      "nextLink": "https://my_vehicles/api?$skiptoken='ERNSH'"
    }
    ```
  </Step>

  <Step>
    Set the Pagination **Type** to `URL`.
  </Step>

  <Step>
    Set the URL Path to `/nextLink`.
  </Step>

  <Step>
    Click the **Create** button at the top of the page to save the REST connection.
  </Step>
</Steps>

## Create the Table

Now that you have added a connection corresponding to a catalog, you can create tables for each of the API's endpoints.

<Steps>
  <Step>
    In your REST connection, click **Tables** to open the Tables tab.
  </Step>

  <Step>
    Click **Add** to add a new table.
  </Step>

  <Step>
    Provide a **Name** for your table. This is the name that the table displays when accessing it from clients. For example: `Vehicles`.
  </Step>

  <Step>
    Leave the **Response Type** as `JSON` and the **Request** call as `GET`.
  </Step>

  <Step>
    Set the **Request URL** to your API endpoint URL. This example uses `https://my_vehicles/api`.
  </Step>

  <Step>
    Leave the **Parameters** section blank, since there are none for this API.
  </Step>

  <Step>
    Similarly, leave **Headers** blank.
  </Step>

  <Step>
    In the **Table Data** section, click **Configure** to automatically fill out the **Table Data** information. This opens the **Preview Request**, which shows the following API response:

    ```json expandable theme={null}
    {
      "people": [
        {
          "personal": {
            "age": 21,
            "gender": "M",
            "name": {
              "first": "John",
              "last": "Doe"
            }
          },
          "vehicles": [
            {
              "type": "car",
              "model": "Honda Civic",
              "insurance": {
                "company": "ABC Insurance",
                "policy_num": "12345"
              },
              "features": [
                "sunroof",
                "rims"
              ],
              "maintenance": [
                {
                  "date": "07-17-2017",
                  "desc": "oil change"
                },
                {
                  "date": "01-03-2018",
                  "desc": "new tires"
                }
              ]
            },
            {
              "type": "truck",
              "model": "Dodge Ram",
              "insurance": {
                "company": "ABC Insurance",
                "policy_num": "12345"
              },
              "features": [
                "lift kit",
                "tow package"
              ],
              "maintenance": [
                {
                  "date": "08-27-2017",
                  "desc": "new tires"
                },
                {
                  "date": "01-08-2018",
                  "desc": "oil change"
                }
              ]
            }
          ]
        },
        ...
      ]
    }
    ```
  </Step>

  <Step>
    Click **Next** to access the Add Columns menu. Here, you must select a root path, and any columns to expose.
    The **Root Path** is the JSON element that contains repeating sub-elements and determines the rows of the table. In this case, you must select multiple root paths because multiple elements repeat in this document. Because the root elements are nested, some data repeats for each row, as shown in this example. Select the `people` element first, because it repeats for each person, as shown in the following snippet from the response:

    ```json theme={null}
    {
         "people": [
             {
             <Person 1 data>
             },
             {
             <Person 2 data>
             }, 
             ...
         ]
     }
    ```

    Also select the `vehicles` and `maintenance` elements, because data from those two repeated sections is also needed.
    *Note: The JSON array uses square brackets `[]` to contain an array of JSON objects which are each contained within angle brackets `{}`.*
  </Step>

  <Step>
    For this example, select `first`, `last` from the people array, `type`, `model` from the vehicles array, and `date`, `desc` from the maintenance array as the columns to expose.
  </Step>

  <Step>
    Click **Next** to access the **Table Preview**. This renders the first 10 rows of the table as currently configured. If configured correctly, you should see data for each column selected:

    | first | last | type | model | date | description |
    | :- | :- | :- | :- | :- | :- |
    | John | Doe | car | Honda Civic | 07-17-2017 | oil change |
    | John | Doe | car | Honda Civic | 01-03-2018 | new tires |
    | John | Doe | truck | Dodge Ram | 08-27-2017 | new tires |
    | John | Doe | truck | Dodge Ram | 01-08-2018 | oil change |
  </Step>

  <Step>
    Click **Confirm** to automatically add your **Table Data** configuration. The data selected should be reflected in the **Root Path** and **Columns** fields in the **Table Data** section.
  </Step>

  <Step>
    Click **Save** to save this table.
  </Step>
</Steps>

## Test Queries

After configuring your connection and your table, you can test it by running queries in the **Data Explorer**.

<Steps>
  <Step>
    Navigate to **Data Explorer**.
  </Step>

  <Step>
    In the **Connections** list, select the `TestAPI` connection created earlier. This expands all of that connection's tables, including the `Vehicles` table created in this example.
  </Step>

  <Step>
    Click the ellipsis next to this table and select **query**. This automatically generates the SQL query to retrieve all vehicles:

    * `SELECT * FROM [TestAPI].[REST].[Vehicles]` You can modify this SQL query as needed. For example, you can add a `WHERE` clause to select only vehicles of a specific model:
    * `SELECT * FROM [TestAPI].[REST].[Vehicles] WHERE model='Honda Civic'`
  </Step>

  <Step>
    Click **Execute** to run this query. If everything is configured correctly, the results are visible immediately.
  </Step>
</Steps>

To connect to this API data from your preferred client, refer to the details documented for the specific client on the **Integrations** page. To access this data, you might need to set the catalog (or database, depending on the client) to `TestAPI`.


# Global Settings
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIGlobalSettings-Embedded



## Summary

Global settings apply to all the tables that can be discovered through a REST connection. This page covers the configuration of authentication, headers, and pagination. Once these are set, you can continue to the **Tables** tab and create [Tables](/en/Data-Sources/APICreateTable-Embedded).

## Authentication

By default, a REST Connector is set to **No Auth**. If your API requires authentication, select the appropriate method and follow the instructions in the relevant tab below. If no authentication is required, click **Save Changes** to save the connector. Next, configure any required Headers and the Pagination type before creating tables.

<Note>
  The authentication method you choose applies to every table added to this connector.
</Note>

<Tabs>
  <Tab title="No Auth">
    No additional settings are required for this authentication method.

    <Steps>
      <Step>
        At the top of the **Add REST Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable-Embedded).
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic Auth">
    <Steps>
      <Step>
        In the **User** field, enter the API username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        At the top of the **Add REST Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable-Embedded).
      </Step>
    </Steps>
  </Tab>

  <Tab title="Digest Auth">
    <Steps>
      <Step>
        In the **User** field, enter the API username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        At the top of the **Add REST Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable-Embedded).
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth 1.0">
    <Steps>
      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need ([https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter your **OAuth Request Token URL** to retrieve request tokens from.
      </Step>

      <Step>
        Enter your **OAuth Authorization URL** so request tokens can be authorized on sign in.

        <Warning>
          The **OAuth Authorization URL** is a direct browser redirect. It does not route through Private Cloud Connector. This URL must be reachable from the end user's browser. URLs that resolve to a private or link-local IP address (such as `10.x.x.x`, `192.168.x.x`, or `169.254.x.x`) are rejected when saving the connection.
        </Warning>
      </Step>

      <Step>
        Enter your **OAuth Access Token URL** so authorized request tokens can be exchanged for access tokens.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the API provider's sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your API provider and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the **Add REST Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable-Embedded).
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth 2.0">
    <Steps>
      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter your **OAuth Authorization URL** so users can be authorized on sign in.

        <Warning>
          The **OAuth Authorization URL** is a direct browser redirect. It does not route through Private Cloud Connector. This URL must be reachable from the end user's browser. URLs that resolve to a private or link-local IP address (such as `10.x.x.x`, `192.168.x.x`, or `169.254.x.x`) are rejected when saving the connection.
        </Warning>
      </Step>

      <Step>
        Enter your **OAuth Access Token URL** so authorization tokens can be exchanged for access tokens.
      </Step>

      <Step>
        Enter your **OAuth Refresh Token URL** so refresh tokens can be exchanged for access tokens when old access tokens expire.
      </Step>

      <Step>
        Select the **OAuth Client Authentication Mode**: **Send as Basic Auth header** or **Send in Post body**. Select the authentication mode that the API provider's documentation recommends. The default value is **Send as Basic Auth header**.
      </Step>

      <Step>
        Enter the **Header Prefix**. The header prefix is incorporated into the Authorization header before the token. The default value is `Bearer`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the API provider's sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your API provider and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the **Add REST Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable-Embedded).
      </Step>
    </Steps>

    #### OAuth 2.0 Custom Parameters

    To add custom parameters to associated requests in OAuth 2.0, do the following:

    <Steps>
      <Step>
        Enter the parameter name in the **Name** field.
      </Step>

      <Step>
        Enter the value of the parameter in the **Value** field.
      </Step>
    </Steps>

    To add more parameters, click **Add Parameter** and repeat the above steps as required.
  </Tab>

  <Tab title="OAuth Client">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter your **OAuth Access Token URL** so authorization tokens can be exchanged for access tokens.
      </Step>

      <Step>
        (Optional) Enter **OAuth Scopes**. These scopes tell the access token what it is permitted to do. Check your API provider's documentation for the scopes it supports.
      </Step>

      <Step>
        Select the **OAuth Client Authentication Mode**: **Send as Basic Auth header** or **Send in Post body**. Select the authentication mode that the API provider's documentation recommends. The default value is **Send as Basic Auth header**.
      </Step>

      <Step>
        Enter the **Header Prefix**. The header prefix is incorporated into the Authorization header before the token. The default value is `Bearer`.
      </Step>

      <Step>
        At the top of the **Add REST Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable-Embedded).
      </Step>
    </Steps>

    #### OAuth Client Custom Parameters

    To add custom parameters to OAuth Client token requests, do the following:

    <Steps>
      <Step>
        Enter the parameter name in the **Name** field.
      </Step>

      <Step>
        Enter the value of the parameter in the **Value** field.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth Password">
    <Steps>
      <Step>
        In the **User** field, enter the API username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned when you registered for OAuth with your API service.
      </Step>

      <Step>
        Enter your **OAuth Access Token URL** so authorization tokens can be exchanged for access tokens.
      </Step>

      <Step>
        (Optional) Enter **OAuth Scopes**. These scopes tell the access token what it is permitted to do. Check your API provider's documentation for the scopes it supports.
      </Step>

      <Step>
        Select the **OAuth Client Authentication Mode**: **Send as Basic Auth header** or **Send in Post body**. Select the authentication mode that the API provider's documentation recommends. The default value is **Send as Basic Auth header**.
      </Step>

      <Step>
        Enter the **Header Prefix**. The header prefix is incorporated into the Authorization header before the token. The default value is `Bearer`.
      </Step>

      <Step>
        At the top of the **Add REST Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable-Embedded).
      </Step>
    </Steps>

    #### OAuth Password Custom Parameters

    To add custom parameters to associated requests in OAuth Password, do the following:

    <Steps>
      <Step>
        Enter the parameter name in the **Name** field.
      </Step>

      <Step>
        Enter the value of the parameter in the **Value** field.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Bearer Token">
    <Steps>
      <Step>
        Enter the **Bearer Token** obtained from your API provider. The bearer token can be obtained from the provider's developer portal, from a command-line tool, or through other means. Refer to your provider's documentation.
      </Step>

      <Step>
        At the top of the **Add REST Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable-Embedded).
      </Step>
    </Steps>
  </Tab>

  <Tab title="API Key">
    <Steps>
      <Step>
        Select the **API Key Type**: **Header** or **Query Parameter**. The key type depends on the API provider. See the provider's API reference for details.
      </Step>

      <Step>
        Enter the **API Key Name**. This is the name of the key that you created in your API provider (usually in the provider's developer portal).
      </Step>

      <Step>
        Enter the **API Key Value**. This value is the key itself; keep it confidential.
      </Step>

      <Step>
        At the top of the **Add REST Connection** page, click **Save Changes** to save the connection.
      </Step>

      <Step>
        After saving the connection, click **Tables** to move on to creating [Tables](/en/Data-Sources/APICreateTable-Embedded).
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Headers

To add HTTP headers that are sent with all API calls, do the following:

<Steps>
  <Step>
    Enter the header name in the **Name** field.
  </Step>

  <Step>
    Specify the value of the header in the **Value** field.
  </Step>
</Steps>

To add more headers, click **Add Header** and repeat the above steps as required.

## Pagination

You can specify the pagination **Type** to use with the REST Connector. First, select the Pagination type. The options available are:

### None

Any API request returns the full dataset in one response.

### Offset

When using offset paging, the connector defines the page size and the number of records to skip when retrieving subsequent pages. For offset paging, set the following values:

* **Offset Param**: The name of the URL parameter defining the API offset in the API request.
* **Page Size Param** (Optional): The name of the URL parameter defining how many records to retrieve per page.
* **Page Size**: The number of records to retrieve per page. The connector uses this value to calculate the offset. Set this to the default page size of the API you are connecting to.

#### Example

In the request below, the user has set **Offset Param** to `pageOffset`, **Page Size Param** to `pageSize`, and **Page Size** to 1000. This example is showing the request for page 6 of data because the connector automatically increments the offset.

```bash theme={null}
https://myapi?pageOffset=5000&pageSize=1000
```

### Number

When using page numbers to control paging, set the following values:

* **Page Number Param**: The name of the URL parameter defining the page number.
* **Page Size Param** (Optional): The name of the URL parameter that defines the page size.
* **Page Size** (Optional): The number of records to retrieve per page.

#### Example

In the request below, the user has set **Page Number Param** to `pageNum`, **Page Size Param** to `pageSize`, and **Page Size** to 1000. This example is showing the request for page 6 of data because the connector automatically increments the page.

```bash theme={null}
https://myapi?pageNum=6&pageSize=1000
```

### Token

When using next page token to control paging, set the following values. The connector automatically includes the token in each request from the previous response.

* **Token Path**: The path in the API response defining the next page token.
* **Has More Path** (Optional): The path in the API response defining whether there are more records available.
* **Token Source**: Select whether the token should be sent in the request as a `URL Parameter` or in the `Request Body`.
* **URL Parameter**: The name of the URL parameter to pass the paging token.
* **Request Body**: The path in the request body where to pass the paging token.

#### Example using Parameters

In the request below, the user has set **URL Parameter** to `pageToken` and **Token Path** to `/results/nextpagetoken`.

**Request:**

```bash theme={null}
https://myapi?pageToken=123456
```

**Response:**

```json theme={null}
{
  "results": [
    {
      "rows": [
        {
          "id": "123",
          "name": "Acme",
          "country": "United States",
          "no_employees": 500
        },
        ...
      ],
      "nextpagetoken": 123457
    }
  ]
}
```

#### Example using Body

In the request below, the user has set **Request Body** to `/request/pageToken`, **Token Path** to `/results/nextpagetoken`, and **Has More Path** to `/results/morePages`.

**Request Body:**

```json theme={null}
{
  "request": [
    {
      "country": "United States",
      "pageToken": 123456
    }
  ]
}
```

**Response:**

```json theme={null}
{
  "results": [
    {
      "rows": [
        {
          "id": "123",
          "name": "Acme",
          "country": "United States",
          "no_employees": 500
        },
        ...
      ],
      "nextpagetoken": 123457,
      "morePages": true
    }
  ]
}
```

### URL

When using next page URLs to control paging, you must first select where the URL for the next page is in the response:

* **Response Type**: Select either `Response Body` if the URL is in the body of the response, or `Response Header` if the URL is in a header of the response.
* **Response Body**: The path in the API response defining the next page URL. This value should be supplied in XPath notation. See the example below.
* **Response Header**: If the next page URL is passed in the response headers with a "Link" header, set this to specify the header name.

#### Example using Path

In the example below, the user has set **Response Body** to `/results/nextpageurl`. Here is an example response which contains the next page URL:

**Response:**

```json theme={null}
{
  "results": [
    {
      "rows": [
        {
          "id": "123",
          "name": "Acme",
          "country": "United States",
          "no_employees": 500
        },
        ...
      ],
      "nextpageurl": "https://myapi?nextpage=81a3ebdb-1483-45cd-84d1-f711d1308698"
    }
  ]
}
```

## Advanced

The **Verbosity** field should be left at `2` unless required for troubleshooting purposes.

After creating a REST connection, proceed to creating [Tables](/en/Data-Sources/APICreateTable-Embedded).

You can add **Retry Status Codes** to retry the request if the API call fails with that status code.


# Mailgun
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Mailgun-Embedded



## Prerequisites

Before you can add the connection, you must obtain an API key from your Mailgun account:

<Steps>
  <Step>
    Log in to your Mailgun account and open the dropdown next to your account name.
  </Step>

  <Step>
    Go to **Account Settings** > **API Security**.
  </Step>

  <Step>
    Click **Create Key** and copy the generated key.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Mailgun to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Mailgun* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Mailgun account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Mailjet
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Mailjet-Embedded



## Prerequisites

Before you can add the connection, you must obtain your API Key and Secret from your Mailjet account:

<Steps>
  <Step>
    Log in to your Mailjet account and go to **My Account** > **REST API** > **API Key Management**.
  </Step>

  <Step>
    Locate your **API Key** and **Secret Key** and copy both values.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Mailjet to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Mailjet* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set the **User** to your Mailjet API Key and the **Password** to your Mailjet API Secret.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Mixpanel
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Mixpanel-Embedded



## Prerequisites

Before you can add the connection, you must create a service account in Mixpanel. You must have Owner or Admin permissions to do this.

<Steps>
  <Step>
    Log in to Mixpanel and go to **Organization Settings** > **Service Accounts**.
  </Step>

  <Step>
    Create a new service account, selecting its role and the projects it can access.
  </Step>

  <Step>
    Copy the generated **Username** and **Secret**. Store them securely. Mixpanel only displays the secret once.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Mixpanel to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Mixpanel* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **User**, which is the service account username from Mixpanel.
  </Step>

  <Step>
    Enter the **Password**, which is the service account secret from Mixpanel.
  </Step>

  <Step>
    Select the **Domain** that corresponds to your data residency region: **mixpanel** (US), **eu.mixpanel** (EU), or **in.mixpanel** (India).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Mode
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Mode-Embedded



## Prerequisites

Before you can add the connection, you must obtain an API access token and API secret from Mode:

<Steps>
  <Step>
    In Mode, open **Workspace Settings** > **Administration** > **API Tokens**.
  </Step>

  <Step>
    Click **Create Token**.
  </Step>

  <Step>
    Copy the **API Access Token** and **Password (Access Secret)**. Store both values securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Mode to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Mode* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **User**, which is your Mode API Access Token.
  </Step>

  <Step>
    Enter the **Password**, which is your Mode Password (Access Secret).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Moosend
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Moosend-Embedded



## Prerequisites

To authenticate to Moosend, you must obtain an API key from your account settings:

<Steps>
  <Step>
    Log in to your Moosend account and click **More** > **Settings** in the top menu bar.
  </Step>

  <Step>
    Select **API key** from the left-hand menu and copy your API key.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Moosend to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Moosend* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** obtained from your Moosend account settings.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Notion
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Notion-Embedded



## Setup Guide

Follow these steps to connect Notion to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Notion* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    To use OAuth authentication, you need to create a public integration with Notion to obtain a client ID and client secret:

    <Steps>
      <Step>
        Go to [Notion integrations](https://www.notion.so/my-integrations) and click **New integration**.
      </Step>

      <Step>
        Select **Public integration** to enable OAuth.
      </Step>

      <Step>
        Configure your integration with a name and workspace.
      </Step>

      <Step>
        Navigate to the **OAuth Domain & URIs** section and add the Connect AI callback URL as your redirect URI: *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        In the **Secrets** section, copy the **OAuth client ID** and **OAuth client secret**. In Connect AI, these are entered as the **OAuth Client Id** and **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Notion.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Notion sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Notion account and select the pages the integration can access.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="APIKey">
    To use API Key authentication, create an internal integration in Notion and copy its integration token:

    <Steps>
      <Step>
        Go to [Notion integrations](https://www.notion.so/my-integrations) and click **New integration**.
      </Step>

      <Step>
        Give the integration a name, associate it with the workspace you want to access, and keep the integration type as **Internal**.
      </Step>

      <Step>
        Create the integration, then copy the **Internal Integration Secret** (the integration token) and store it securely.
      </Step>

      <Step>
        In the **More** menu, share your Notion pages and databases with this integration to grant it access.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **API Key**, which is the Notion integration token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Omnisend
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Omnisend-Embedded



## Prerequisites

Before you can add the connection, you must find your API key in your Omnisend account:

<Steps>
  <Step>
    Log in to your Omnisend account and go to [https://app.omnisend.com/#/my-account/integrations/api-keys](https://app.omnisend.com/#/my-account/integrations/api-keys).
  </Step>

  <Step>
    Copy your **API key** and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Omnisend to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Omnisend* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your Omnisend account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Optimizely
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Optimizely-Embedded



## Prerequisites

Before you can add the connection, you must register an OAuth application with Optimizely:

<Steps>
  <Step>
    Log in to your Optimizely account and go to [https://app.optimizely.com/accountsettings/apps/developers](https://app.optimizely.com/accountsettings/apps/developers).
  </Step>

  <Step>
    Register a new application. Optimizely assigns your app an **OAuth Client ID** and **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Optimizely to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Optimizely* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Optimizely.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Optimizely sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Optimizely account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PagerDuty
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-PagerDuty-Embedded



## Prerequisites

Before you can add the connection, you must register an OAuth application in PagerDuty:

<Steps>
  <Step>
    Log in to your PagerDuty account and click the app icon to the left of your profile picture.
  </Step>

  <Step>
    Select **Developer Mode** to open the **My Apps** page.
  </Step>

  <Step>
    Click **Create New App**.
  </Step>

  <Step>
    Enter a name and description for the application.
  </Step>

  <Step>
    Set the **Redirect URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save the application, then copy the **Client ID** and **Client Secret**. Store the secret securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect PagerDuty to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PagerDuty* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from PagerDuty.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the PagerDuty sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your PagerDuty account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Paymo
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Paymo-Embedded



## Prerequisites

Before you can add the connection, you must generate an API key from your Paymo account:

<Steps>
  <Step>
    Log in to your Paymo account and navigate to **My Settings**.
  </Step>

  <Step>
    Under **Integrations**, select **API Keys**.
  </Step>

  <Step>
    Click **Generate New Key** and copy the key. Store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Paymo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Paymo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Perplexity
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Perplexity-Embedded



## Prerequisites

Before you can add the connection, you must generate an API key from your Perplexity account:

<Steps>
  <Step>
    Go to the [Perplexity API dashboard](https://www.perplexity.ai/settings/api) and generate a new key.
  </Step>

  <Step>
    Copy the key and store it securely.
  </Step>
</Steps>

The API key provides access to asynchronous chat completion jobs and results.

## Setup Guide

Follow these steps to connect Perplexity to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Perplexity* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your Perplexity account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Polar Team Pro
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-PolarTeamPro-Embedded



## Prerequisites

Before you can add the connection, you must register an OAuth application with Polar Team Pro:

<Steps>
  <Step>
    Navigate to the [Polar AccessLink admin portal](https://admin.polaraccesslink.com/) and log in.
  </Step>

  <Step>
    Click **Create New Application**.
  </Step>

  <Step>
    Enter an application name and set the **Redirect URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Click **Register**. The portal displays your **Client ID** and **Client Secret**. Store these values securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Polar Team Pro to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Polar Team Pro* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the Polar AccessLink admin portal.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Polar Team Pro sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Polar Team Pro account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Printful
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Printful-Embedded



## Prerequisites

Before you can add the connection, you must generate an API key from your Printful store:

<Steps>
  <Step>
    Log in to your Printful account and navigate to **Settings** > **Stores**.
  </Step>

  <Step>
    Select the store you want to connect.
  </Step>

  <Step>
    Click **Add API Access** to generate an API key, then copy it and store it securely.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Printful to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Printful* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** generated from your Printful store settings.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Printify
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Printify-Embedded



## Prerequisites

Before you can add the connection, you must generate a Personal Access Token from your Printify account:

<Steps>
  <Step>
    Log in to your Printify account and navigate to **My Profile**, then **Connections**.
  </Step>

  <Step>
    In the **Connections** section, set your **Token Access Scopes**, then generate your Personal Access Token. Copy the token. Store it securely. Tokens are valid for one year and can be re-generated after expiration.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Printify to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Printify* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **API Key**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Procore
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Procore-Embedded



## Setup Guide

Follow these steps to connect Procore to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Procore* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    Use this method to authenticate as an individual user through an interactive browser sign-in. First register an OAuth application in the Procore Developer Portal:

    <Steps>
      <Step>
        Sign in to the [Procore Developer Portal](https://developers.procore.com/) and open **My Apps**.
      </Step>

      <Step>
        Click **Create New App**, enter an app name, and create the app.
      </Step>

      <Step>
        Create a new version of the **Sandbox** manifest and add an **OAuth** (authorization code) component.
      </Step>

      <Step>
        Set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
      </Step>

      <Step>
        Promote the manifest to **Production** to obtain your production credentials.
      </Step>

      <Step>
        On the app page, make note of the **Client ID** and **Client Secret**. In Connect AI, the Client ID is entered as the **OAuth Client Id** and the Client Secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Procore.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Procore sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Procore account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    Use this method for a service-to-service connection that authenticates with the OAuth client credentials grant, without an interactive browser sign-in. First register a service account application in the Procore Developer Portal:

    <Steps>
      <Step>
        Sign in to the [Procore Developer Portal](https://developers.procore.com/) and open **My Apps**.
      </Step>

      <Step>
        Click **Create New App**, enter an app name, and create the app.
      </Step>

      <Step>
        Create a new version of the **Sandbox** manifest and add a **Data Connection** (service account) component, which uses the client credentials grant.
      </Step>

      <Step>
        Promote the manifest to **Production** to obtain your production credentials.
      </Step>

      <Step>
        On the app page, make note of the **Client ID** and **Client Secret**. In Connect AI, the Client ID is entered as the **OAuth Client Id** and the Client Secret as the **OAuth Client Secret**.
      </Step>
    </Steps>

    In Connect AI:

    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from Procore.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Sage HR
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-SageHR-Embedded



## Prerequisites

Before you can add the connection, you must obtain an API key from your Sage HR account:

<Steps>
  <Step>
    Click your name in the top-right corner, then click **Settings**.
  </Step>

  <Step>
    In the settings menu, click **INTEGRATIONS**, then click **API**.
  </Step>

  <Step>
    Click **ENABLE API ACCESS** to activate API access and generate your unique API key.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Sage HR to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Sage HR* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your **Subdomain**. This is the subdomain of your Sage HR account URL (for example, if your account URL is mycompany.sage.hr, enter *mycompany*).
  </Step>

  <Step>
    Enter the **API Key** generated from your Sage HR account.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Samanage
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Samanage-Embedded



## Prerequisites

Before you can add the connection, you must generate a JSON web token from your Samanage account:

<Steps>
  <Step>
    Log in to your Samanage account and navigate to **Setup** > **Users**.
  </Step>

  <Step>
    Click your username to open your **User Detail** page.
  </Step>

  <Step>
    In the **Action** drop-down menu, select **Generate JSON Web Token** and copy the token.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Samanage to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Samanage* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **API Key** (JSON web token) generated in the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SendPulse
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIP-Sendpulse-Embedded



## Prerequisites

Before you can add the connection, you must obtain OAuth credentials from your SendPulse account:

<Steps>
  <Step>
    Log in to your SendPulse account.
  </Step>

  <Step>
    Navigate to **Account Settings** and open the **API** tab.
  </Step>

  <Step>
    Locate your **Client ID** and **Secret Key** and copy both values.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SendPulse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SendPulse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from your SendPulse account.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the SendPulse sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your SendPulse account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Permissions
Source: https://docs.cloud.cdata.com/en/Data-Sources/APIPermissions-Embedded

The permissions settings provide a way to manage the access of different users to your connected API. The permissions tab contains an active list of users and their assigned capabilities.

Set permissions for each user by checking or unchecking the boxes next to their user name that aligns to the following privileges:

* **Select** data from the API’s database.
* **Insert** data into the API’s database.
* **Update** data in the API’s database.
* **Delete** data from the API’s database.
* **Execute** functions on the API’s database.

To save your changes before navigating away, click the **Save Changes** button on the top right.

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft Entra ID
Source: https://docs.cloud.cdata.com/en/Data-Sources/AzureAD-Embedded



## Setup Guide

Follow these steps to connect Microsoft Entra ID to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft Entra ID* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Microsoft Entra ID sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Microsoft Entra ID account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant** that you use to access data.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter your **OAuth Client Id** assigned when you registered your Microsoft Entra ID account.
      </Step>

      <Step>
        Enter your **OAuth Client Secret** assigned when you registered your Microsoft Entra ID account for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **Azure Tenant** that you use to access data.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter your **OAuth Client Id** assigned when you registered your Microsoft Entra ID account.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert**, the contents of the JWT certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert Password** (optional) if the certificate store requires it.
      </Step>

      <Step>
        Enter the **OAuth JWT Cert Subject** (optional). This is the subject of the OAuth JWT certificate. If omitted, the first certificate in the certificate store is used.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft Entra ID, see [this information page](https://cdn.cdata.com/help/CJJ/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MoneyForward Expense
Source: https://docs.cloud.cdata.com/en/Data-Sources/MFExpense-Embedded



## Prerequisites

Before you can connect to Connect AI, you must create OAuth client credentials in MoneyForward Expense.

Follow these steps:

<Steps>
  <Step>
    Log in to your MoneyForward Expense account.
  </Step>

  <Step>
    In the **For Developers** section, click **API Linkage**.
  </Step>

  <Step>
    Click **Create Application**.
  </Step>

  <Step>
    Set the **Redirect URI** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Set **Scopes** to *office\_setting:write user\_setting:write transaction:write report:write account:write public\_resource:read*.
  </Step>

  <Step>
    Save your changes. You will use the values for **OAuth Client Id** and **OAuth Client Secret** for your connection.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect MoneyForward Expense to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MoneyForward Expense* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    In Connect AI, enter the following connection information:

    * **OAuth Client Id**—the client Id generated in the prerequisites.
    * **OAuth Client Secret**—the client secret generated in the prerequisites.
    * **Office Id**—the Id of the office. This is required for most queries.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the MoneyForward Expense sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your MoneyForward Expense account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MoneyForward Expense, see [this information page](https://cdn.cdata.com/help/EYM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft Teams
Source: https://docs.cloud.cdata.com/en/Data-Sources/MSTeams-Embedded



## Setup Guide

Follow these steps to connect Microsoft Teams to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft Teams* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Microsoft Teams sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Microsoft Teams account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft Teams account.
        * **OAuth Client Secret**—the client secret for your Microsoft Teams account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft Teams account.
        * **OAuth JWL Cert**—the contents of the JWT certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft Teams, see [this information page](https://cdn.cdata.com/help/GSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MYOB
Source: https://docs.cloud.cdata.com/en/Data-Sources/MYOB-Embedded



## Setup Guide

Follow these steps to connect MYOB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MYOB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select your **Instance**.
  </Step>

  <Step>
    In **User**, enter the MYOB username for authentication.
  </Step>

  <Step>
    Enter the user password into the **Password** field.
  </Step>

  <Step>
    Enter the **Company File Id**. If not specified, the ID of the first returned company file is used.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the MYOB sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your MYOB account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MYOB, see [this information page](https://cdn.cdata.com/help/UMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MariaDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/MariaDB-Embedded



## Prerequisites

#### Whitelist CData IPs

To establish a connection to MariaDB, you need to allow access to MariaDB via CData’s IP. When hosting MariaDB behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure MariaDB Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect MariaDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MariaDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the MariaDB server in the **Server** field.
  </Step>

  <Step>
    Enter the port for connecting to the MariaDB server in the **Port** field. This is `3306` by default.
  </Step>

  <Step>
    In the **User** field, enter the MariaDB username for authentication.
  </Step>

  <Step>
    Enter the user password in the **Password** field.
  </Step>

  <Step>
    (Optional) Enter the name of the MariaDB **Database**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MariaDB, see [this information page](https://cdn.cdata.com/help/SRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MarkLogic
Source: https://docs.cloud.cdata.com/en/Data-Sources/MarkLogic-Embedded



## Setup Guide

Follow these steps to connect MarkLogic to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MarkLogic* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **User**, which specifies the authenticating user's ID.
  </Step>

  <Step>
    Enter the **Password**, which specifies the authenticating user's password.
  </Step>

  <Step>
    Enter the **Server**, which is the address of the MarkLogic server to which you are connecting.
  </Step>

  <Step>
    (Optional) Enter the **Port**, which is the ODBC server port for MarkLogic.
  </Step>

  <Step>
    (Optional) Enter the **Database**, which is the name of the MarkLogic database to connect to.
  </Step>

  <Step>
    (Optional) Select the **API** which the provider uses to query data. The available options are **ODBC** (connect to the ODBC server) and **REST** (connect to the REST API). The default is **ODBC**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MarkLogic, see [this information page](https://cdn.cdata.com/help/OMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Marketo
Source: https://docs.cloud.cdata.com/en/Data-Sources/Marketo-Embedded



## Prerequisites

Before obtaining OAuth credentials, you need to create a custom service in Marketo if you do not already have one. This procedure involves creating a new role with REST API privileges, assigning that role to an existing or new user, and then creating a new service.

Note that only users with Admin privileges can create a Custom Service and that the term “service” refers to the entity created to provide OAuth credentials for API access.

**Step 1: Create a New Role for API Access**

<Steps>
  <Step>
    Navigate to the Marketo application's **Admin** area.
  </Step>

  <Step>
    Navigate to the **Security** section.
  </Step>

  <Step>
    Click **Users & Roles**.
  </Step>

  <Step>
    Select the **Roles** tab.
  </Step>

  <Step>
    Click **New Role**.
  </Step>

  <Step>
    Specify a Role Name and select Role permissions. Specify Access API permissions that are specific to the REST API.
  </Step>
</Steps>

**Step 2: Assign or Create a New User for API Access**

<Steps>
  <Step>
    Select the **Users** tab.
  </Step>

  <Step>
    To assign the role to a user, click **Invite New User**.
  </Step>

  <Step>
    Enter the new user information and assign them the role you just created with REST API access.
  </Step>

  <Step>
    To denote the user as an API Only user, select the **API Only** option.
  </Step>
</Steps>

**Step 3: Create the New Service**

<Steps>
  <Step>
    Navigate to **Admin** > **Integration** and click the **LaunchPoint** option.
  </Step>

  <Step>
    Click **New Service**.
  </Step>

  <Step>
    Specify the Service Type as **Custom**.
  </Step>

  <Step>
    Enter a display name and description for the service.
  </Step>

  <Step>
    Assign the user you just created to the service.
  </Step>
</Steps>

Once you have a custom service, do the following:

<Steps>
  <Step>
    Go to the **Admin** tab.
  </Step>

  <Step>
    Click the **LaunchPoint** option.
  </Step>

  <Step>
    Select the custom service and click **View Details**. Marketo displays a window that shows the authentication credentials.
  </Step>

  <Step>
    Copy and paste the Client Id as the **OAuthClientId** and the Client Secret as the **OAuthClientSecret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Marketo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Marketo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Marketo **URL**. You can locate this in **Admin** > **Integration** > **Web Services** > **REST API**. Example values: *[https://123-abc-456.mktorest.com/](https://123-abc-456.mktorest.com/)* or *[https://123-abc-456.mktorest.com/rest](https://123-abc-456.mktorest.com/rest)*.
  </Step>

  <Step>
    Paste the **OAuth Client Id** you obtained in the prerequisites.
  </Step>

  <Step>
    Paste **OAuth Client Secret** you obtained in the prerequisites.
  </Step>

  <Step>
    (Optional) Set **Use Bulk API** to True to let it handle bulk requests of certain large datasets.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Marketo, see [this information page](https://cdn.cdata.com/help/DKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft Planner
Source: https://docs.cloud.cdata.com/en/Data-Sources/MicrosoftPlanner-Embedded



## Setup Guide

Follow these steps to connect Microsoft Planner to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft Planner* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Microsoft Planner sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Microsoft Planner account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft Planner account.
        * **OAuth Client Secret**—the client secret for your Microsoft Planner account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft Planner account.
        * **OAuth JWL Cert**—the contents of the JWT certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft Planner, see [this information page](https://cdn.cdata.com/help/UIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft Project
Source: https://docs.cloud.cdata.com/en/Data-Sources/MicrosoftProject-Embedded



## Setup Guide

Follow these steps to connect Microsoft Project to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft Project* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** for your Microsoft Project Web App (for example, `https://MyOrganization.sharepoint.com/sites/pwa/`).
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="SharePointOnlineCookies">
    <Steps>
      <Step>
        Enter the Microsoft Project username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your Microsoft Project account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your Microsoft Project account for OAuth.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Add the **Password** for that account.
      </Step>

      <Step>
        Set the **SSO Login URL** to the URL used by the SSO provider.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Microsoft Project username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        Enter the **SSO Login URL**.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OneLogin">
    <Steps>
      <Step>
        Enter the Microsoft Project username for authentication in the **User** field.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant** Id that you will use to access data.
      </Step>

      <Step>
        Enter all relevant **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter your **OAuth Client Id**.
      </Step>

      <Step>
        Enter your **OAuth Client Secret**.
      </Step>

      <Step>
        Select a **Schema** from the drop down. ODataV1 includes more granular data, while ODataV2 can be used for full CRUD operations.
      </Step>

      <Step>
        (Optional) Enter the default **Project Id** name to define it for all operations which require one.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft Project, see [this information page](https://cdn.cdata.com/help/COM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Monday.com
Source: https://docs.cloud.cdata.com/en/Data-Sources/Monday-Embedded



## Setup Guide

Follow these steps to connect Monday.com to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Monday.com* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Schema** then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## AuditLog Schema

<Steps>
  <Step>
    Enter your **Domain**. This follows the format `https://yourdomain.monday.com`.
  </Step>

  <Step>
    Enter the **Api Token** generated in your Monday account under **Manage Application**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## GraphQL Schema

Select the Authentication method, then proceed to the relevant section and follow those instructions.

### Token

<Steps>
  <Step>
    Enter the **Api Token** generated in your Monday account under **Manage Application**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

### OAuth

<Steps>
  <Step>
    Enter the **OAuth Client Id** assigned when you registered your Monday.com account for OAuth.
  </Step>

  <Step>
    Enter the **OAuth Client Secret** for your Monday.com account for OAuth.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Monday.com sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Monday.com account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Monday.com, see [this information page](https://cdn.cdata.com/help/MOJ/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MongoDB
Source: https://docs.cloud.cdata.com/en/Data-Sources/MongoDB-Embedded



## Prerequisites

#### Whitelist CData IPs

To establish a connection to MongoDB, you need to allow access to MongoDB via CData’s IP. When hosting MongoDB behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure MongoDB Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect MongoDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MongoDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the MongoDB server in the **Server** field.
  </Step>

  <Step>
    Specify the port for connecting to the MongoDB server in the **Port** field. By default this is set to 27017.
  </Step>

  <Step>
    Enter the name of the MongoDB **Database**.
  </Step>

  <Step>
    Select the **Auth Scheme** you use to connect to MongoDB. Options are: `MONGODB-CR`, `SCRAM-SHA-1`, `SCRAM-SHA-256`, and `X509`.
  </Step>

  <Step>
    Enter the MongoDB username for authentication in the **User** field.
  </Step>

  <Step>
    In the **Password** field, enter the user password.
  </Step>

  <Step>
    (Optional) If the authentication database is different from the database to retrieve data from, enter it into the **Auth Database** field.
  </Step>

  <Step>
    In MongoDB, add the Connect AI static IP addresses to your connection whitelist.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

### Connect to Replica Sets

<Steps>
  <Step>
    To connect to a replica set, click on **Advanced Settings**.
  </Step>

  <Step>
    Set **Replica Set** to a list of comma-separated list of secondary servers, specified by address and port.
  </Step>

  <Step>
    Set **Slave OK** to `True`.
  </Step>

  <Step>
    Set **Read Preference** to determine how the provider reads from the secondary servers.

    * `primary` executes all SELECT queries against the primary server.
    * `primaryprefered` executes SELECT queries from a secondary server when the primary is not available.
    * `secondary` executes SELECT queries on secondary servers only.
    * `secondary prefered` executes SELECT queries on the primary server in the event no secondaries are available.
    * `nearest` executes SELECT queries on whichever server has the least latency.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and MongoDB, see [this information page](https://cdn.cdata.com/help/DGM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# MySQL
Source: https://docs.cloud.cdata.com/en/Data-Sources/MySQL-Embedded



## Prerequisites

#### Whitelist CData IPs

To establish a connection to MySQL, you need to allow access to MySQL via CData’s IP. When hosting MySQL behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure MySQL Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect MySQL to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *MySQL* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    If your MySQL connection is behind a firewall, set the **Connection Type** to **SSH Tunnel** and follow the instructions in [SSH Tunnel Instructions](#ssh-tunnel-instructions). Then continue with these instructions. Otherwise, leave the **Connection Type** as **Direct**.
  </Step>

  <Step>
    Enter the following information:

    * **Server**—the host name or IP address of the MySQL server. Cluster servers are supported (for example, `192.168.0.1,192.168.0.2`).
    * **Port**—the port for connecting to the MySQL server.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the MySQL username for authentication.
        * **Password**—the user password.
        * **Database**—(Optional) the name of the MySQL database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the MySQL username for authentication.
        * **Azure Tenant**—the MySQL tenant that you want to use to access data.
        * **Database**—(Optional) the name of the MySQL database.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the MySQL sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your MySQL account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Azure Password">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the MySQL username for authentication.
        * **Password**—the user password.
        * **Azure Tenant**—the MySQL tenant that you want to use to access data.
        * **Database**—(Optional) the name of the MySQL database.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## SSH Tunnel Instructions

If your MySQL data source is behind a firewall, follow these instructions.

<Steps>
  <Step>
    Click **Connection Type** of **SSH Tunnel**.
  </Step>

  <Step>
    Enter the following information:

    * **SSH Server**–enter the name of the SSH server.
    * **SSH Port**–enter the SSH port. The default value is 22.
    * **SSH Auth Mode**–enter the authentication mode of **Password** or **Public\_Key**.
      * If **Password**, enter the **SSH User** name and **SSH Password**.
      * If **Public\_Key**, enter the **SSH User** name, **SSH Client Cert**, and **SSH Client Cert Password** (optional). Only PEMKEY\_BLOB is available as the **SSH Client Cert Type**. The **SSH Client Cert** is required, and is a valid private key. Enter the **SSH Client Cert Password** if the SSH client certificate has a password.
  </Step>

  <Step>
    Continue with the authentication instructions in the [Setup Guide](#setup-guide).
  </Step>
</Steps>

## Private Cloud Connector Connection

MySQL is a supported connector with Private Cloud Connector, which acts as a bridge between your on-premises data and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information. Once you set up the gateway, you can select the **Connection Type** of **Private Cloud Connector**. Then enter **Location Name** of the gateway and the MySQL authentication information.

## More Information

For more information about interactions between Connect AI and MySQL, see [this information page](https://cdn.cdata.com/help/DMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Neo4j
Source: https://docs.cloud.cdata.com/en/Data-Sources/Neo4j-Embedded



## Setup Guide

Follow these steps to connect Neo4j to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Neo4j* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Server** hosting the Neo4j instance. You may optionally prepend a HTTP or HTTPS protocol prefix to the server address or name you specify, for example, [https://127.0.0.1](https://127.0.0.1). The default value is 127.0.0.1.
  </Step>

  <Step>
    Enter the **Port** used for connecting to the Neo4j server. The default value is 7474. If connecting over HTTPS, supply the HTTPS port for the Neo4j instance specified in the **Server** field.
  </Step>

  <Step>
    Enter the **API** to connect to in your Neo4j instance, **Query** or **HTTP**.
  </Step>

  <Step>
    Enter the **User** Id for the authenticating user.
  </Step>

  <Step>
    Enter the **Password** for the authenticating user.
  </Step>

  <Step>
    Enter the **Database** to target in the Neo4j instance. The default value is Neo4j.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Neo4j, see [this information page](https://cdn.cdata.com/help/LNK/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# NetSuite
Source: https://docs.cloud.cdata.com/en/Data-Sources/NetSuite-Embedded

NetSuite supports two connection methods: SuiteQL and SuiteTalk. Each method has benefits and drawbacks, as outlined below. For most users, CData recommends using SuiteQL.

For a detailed discussion about the differences between SuiteTalk and SuiteQL, see the [NetSuite driver documentation](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_suiteql).

### SuiteQL

SuiteQL is the newer of the two connection methods. This method offers much better performance, especially when you issue large queries. It also supports rich join support, grouping, aggregation, custom list tables, and retrieval of specific columns in your data.

However, SuiteQL only supports SELECT queries. As a result, you cannot issue INSERT, UPDATE, or DELETE queries to NetSuite when you are connected via SuiteQL.

### SuiteTalk

SuiteTalk is the older of the two connection methods. This method provides broad entity support and full support for INSERT, UPDATE, and DELETE queries. However, it often performs poorly during large SELECT queries and lacks reliable table joining capabilities. You also cannot group or aggregate data using SuiteTalk.

For performance and reliability reasons, CData recommends using SuiteTalk only if you require access to INSERT, UPDATE, and DELETE queries for your connection to NetSuite.

## Setup Guide

To configure your NetSuite connection, follow these steps:

<Steps>
  <Step>
    Configure [user roles](#configure-roles).
  </Step>

  <Step>
    Choose a connection method (SuiteQL/OAuth or SuiteTalk/Token). Note that NetSuite does not support basic authentication through username and password credentials in recent versions. Connect AI recommends using OAuth or Token authorization.
  </Step>

  <Step>
    Follow the steps under [Connect to NetSuite](#connect-to-netsuite) to establish the connection.
  </Step>
</Steps>

### Configure Roles

Connect AI communicates with NetSuite through NetSuite Web services. If the user account that you will use for establishing the connection does not have NetSuite Web services permissions, follow these steps to create them:

<Steps>
  <Step>
    Log in to NetSuite as an administrator. From the navigation bar, select **Setup** > **Users/Roles** > **Manage Roles**.
  </Step>

  <Step>
    Choose an existing role or create a new one, depending on your needs.
  </Step>

  <Step>
    On the **Edit Role** page, navigate to the **Permissions** section.
  </Step>

  <Step>
    Expand the **Setup ()** field.
  </Step>

  <Step>
    In a blank slot, select **SOAP Web Services** and click **Add** to add the permission.
  </Step>

  <Step>
    In another blank slot, select **REST Web Services** and click **Add** to add the permission.
  </Step>

  <Step>
    Add additional permissions.

    * If you plan to connect to NetSuite via SuiteQL/OAuth, add the **OAuth 2.0 Authorized Applications Management** permission.
    * If you plan to connect to NetSuite via SuiteTalk/Token add the **User Access Token** and **Access Token Management** permissions.
      **Important: See [Permission Configurations](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_permissions) in the NetSuite driver documentation for additional permissions that may be needed.**
  </Step>

  <Step>
    When you finish, return to the top of the page and click **Save** to save the role.
  </Step>
</Steps>

Next, add this role to an employee:

<Steps>
  <Step>
    From the navigation bar, select **Lists** > **Employees** > **Employees**. Select an employee or add a new one.
  </Step>

  <Step>
    Scroll to the **Access** section. In the **Roles** subsection, add the role that you created.
  </Step>

  <Step>
    Scroll to the top and click **Save**.
  </Step>
</Steps>

Continue to Connecting to NetSuite below.

### Connect to NetSuite

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *NetSuite* in the **Add Connection** dialog that opens. Click the data-source name when it is displayed.
  </Step>

  <Step>
    On a separate browser tab, log in to your NetSuite account as an administrator role.
  </Step>

  <Step>
    From the top navigation bar, select **Setup** > **Company** > **Company Information**.
  </Step>

  <Step>
    Copy the value for **Account Id** to your clipboard.
  </Step>

  <Step>
    Return to Connect AI and enter the copied value into the **Account Id** field .
  </Step>

  <Step>
    For the **Schema** field, select either SuiteQL or SuiteTalk.
    **Note:** CData recommends SuiteQL for most use cases. Click [here](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_suiteql) for information on the differences between SuiteQL and SuiteTalk.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions. Note that OAuth is only available if SuiteQL is selected, and Basic is only available when Suitetalk is selected.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the NetSuite sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your NetSuite account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        In NetSuite, navigate to **Setup** > **Company** > **Enable Features**.
      </Step>

      <Step>
        Open the **SuiteCloud** tab and scroll to **Manage Authentication**. Make sure the checkbox **Token-Based Authentication** is selected, then scroll to the top and click **Save**.
      </Step>

      <Step>
        Navigate to **Setup** > **Integration** > **Manage Integrations**.
      </Step>

      <Step>
        Create a new integration. Under **Token-based Authentication**, select the **Token-Based Authentication** and **TBA: Authorization Flow** checkboxes.
      </Step>

      <Step>
        In the **Callback URL** field, enter `https://oauth.cdata.com/oauth/`.
      </Step>

      <Step>
        In the **OAuth 2.0** section, if you do not plan to use OAuth elsewhere with this integration, clear the **Authorization Code Grant** checkbox.
      </Step>

      <Step>
        Copy the values for **Consumer Key / Client ID** and **Consumer Secret / Client Secret** from the **Client Credentials** section. You need these values later. (**Note:** If you click **Save** before you copy the consumer key and secret, click **Edit** then **Reset Credentials**.)
      </Step>

      <Step>
        Click **Save** to save the integration.
      </Step>
    </Steps>

    Next, create an access token by following these steps:

    <Steps>
      <Step>
        From the navigation bar, select **Setup** > **Users/Roles** > **Access Tokens**.
      </Step>

      <Step>
        Create a new access token. For the application name, select the integration you created.
      </Step>

      <Step>
        In the **User** and **Role** fields, use the same user and role from the [Configure Roles](#configure-roles) section.
      </Step>

      <Step>
        Click **Save**. Copy the credentials for **Token ID** and **Token Secret**.
      </Step>

      <Step>
        Return to Connect AI and enter your **OAuth Client Id**.
      </Step>

      <Step>
        Enter your Client or Consumer secret into **OAuth Client Secret**.
      </Step>

      <Step>
        Enter your **OAuth Access Token** Id.
      </Step>

      <Step>
        Enter your **OAuth Access Token Secret**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter the following information:

        * **JWT Scope**–the level of access the token provides to NetSuite data. Valid values include *restlets*, *rest\_webservices*, and *suite\_analytics*. You can specify multiple scopes by separating them with commas.
        * **OAuth JWT Encryption**–select from the drop-down list. This is the encryption algorithm to be used in JWT authentication.
        * **OAuth JWT Headers**–a collection of extra headers to include in the JWT. Each header is a name=value pair. Each pair is separated by a comma.
        * **OAuth JWT Cert**–the contents of the client certificate's JWT certificate store.
        * **OAuth JWT Cert Type**–the type of key store containing the JWT certificate.
        * **OAuth JWT Issuer**–the issuer of the Java Web Token. This is typically either the client Id or email address of the OAuth application.
        * **OAuth JWT Validity Time**–(optional) the length of time the JWT should remain valid, in seconds. The default value is 3600 seconds.
        * **OAuth JWT Cert Password**–(optional) the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave blank.
        * **OAuth JWT Cert Subject**–(optional) the subject of the OAuth JWT certificate used to locate a matching certificate in the store. The wildcard '\*' selects the first certificate.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Note>
      This version is only supported on older versions of NetSuite and is not recommended.
    </Note>

    <Steps>
      <Step>
        In the **User** field, enter the NetSuite username for authentication.
      </Step>

      <Step>
        Enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and NetSuite, see [this information page](https://cdn.cdata.com/help/DNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# NetSuite Custom Reports
Source: https://docs.cloud.cdata.com/en/Data-Sources/NetSuiteRESTlet-Embedded

NetSuite users who connect with SuiteTalk can use RESTlets or saved searches to create custom reports in Connect AI.

<Note>
  **Note:** RESTlets and saved searches are not compatible with SuiteQL.
</Note>

## RESTlets

This section shows how to use a RESTlet script to query saved searches.

<Note>
  **Note:** Using RESTlets is the recommended way to query saved searches. Using RESTlets is different from the method described in [Saved Searches](#saved-searches). This older method relies on the SuiteTalk API, which is more limited in what saved searches can return.
</Note>

### Create a RESTlet Script

Open a new file in a text editor. Then copy and paste the following RESTlet script and save it as `search_script.js`:

```bash expandable theme={null}
/**
 *@NApiVersion 2.x
 *@NScriptType Restlet
 */
define(['N/search'],
    function (search) {
        // Get a standard NetSuite record
        function _get(context) {
            var myTransactionSearch = search.load({
                id: context.searchid
            });
            var pagedData = myTransactionSearch.runPaged({
                pageSize: 1000
            });
            if (pagedData.count == 0) {
                return JSON.stringify({
                    "pagedData": {
                        "searchDefinition": {
                            "count": [
                                {"columnCount":0}
                            ]
                        }
                    }
                });
            }
            var results = pagedData.fetch({
                index: context.index
            })
            return JSON.stringify(results);
        }

        return {
            get: _get
        };
    });
```

### Using RESTlets to Query Saved Searches

Follow the steps below to deploy the RESTlet script and execute the RESTlet.

#### Enable SuiteScript

Go to **Setup** > **Company** > **Enable Features**. Under the **SuiteCloud** tab, ensure the options for **Client SuiteScript**, **Server SuiteScript**, and **SuiteScript Server Pages** are all enabled.

#### Upload the SuiteScript File

Go to **Documents** > **Files** > **SuiteScripts**. Click the **Add File** button. Upload the `search_script.js` script that you created in [Create a RESTlet Script](#create-a-restlet-script).

#### Create a Script Record

Go to **Customization** > **Scripting** > **Scripts** > **New**. From the menu, find `search_script.js` and select it. Then click **Create Script Record**.

#### Deploy the Script Record

Give the script a name and under the **Deployments** tab add a title. Then click **Save**. This creates a deployment.

<Note>
  **Note:** While the status of the Script Deployment is **Testing**, only the user that created the deployment returns results from any saved searches queried. To make the RESTlet available for other users, update the Status of the Script Deployment to **Released** and add supported roles in the **Audience** tab.
</Note>

#### Get the Deployment / Script Id

You can find a link to the deployment in the Script Record. Follow the link to the deployment. Or, you can also go to **Customization** > **Scripting** > **Script Deployments** and use the filters to find the deployment you made. In the deployment record, you can see a URL and External URL. Copy the script number and deployment number from this URL.

#### Get a Saved Search Id

To execute `search_script.js`, you need to pass it the Id of a saved search: Go to **Lists** > **Search** > **Saved Searches** and copy in the Id of a saved search. We recommend you use a search that is ordered by a column that always gives the same ordering, such as the Date Created. This is because NetSuite does not cache results that can cause duplicates or missing data if data is changed while you are paging through the results.

#### Add a Custom Report

<Steps>
  <Step>
    In the **Sources** page of Connect AI, select your NetSuite connection.
    If you do not yet have a NetSuite connection, follow the steps in the NetSuite [Setup Guide](/en/Data-Sources/NetSuite#setup-guide).
  </Step>

  <Step>
    Click the **Custom Reports** tab and click **Add** to add a new report.
    An **Add Custom Report** dialog appears.
  </Step>

  <Step>
    Select **RestletSchema** and click **Confirm**.
  </Step>

  <Step>
    Enter the following information:

    * **Name**—the name of the custom report.
    * **SearchId**—the Id of the saved search obtained in the NetSuite UI.
    * **ScriptID**—the Script Id of the RESTlet to create a schema for.
    * **DeploymentNum**—the deployment number of the RESTlet schema to execute. Typically, this number is 1.
  </Step>

  <Step>
    Select whether to **UseLabels**. This determines if the NetSuite connector should try to match column names to what would appear in the Saved Search results or just use the API name returned by the saved search itself. Note that even when UseLabels is set to true, names are converted to alphanumeric with underscores. Also, be aware that sometimes labels come back with identical names for saved searches. In these cases, a number is appended to the duplicate names to keep the names unique.
  </Step>

  <Step>
    Select whether to **FlattenSelects**. Set this parameter to false if your saved search includes multiselect columns. This parameter controls how the NetSuite connector models the data types of selects (such as an entity / customer reference). When FlattenSelects is set to false, multiselect data is returned as a JSON aggregate.
    By default, the NetSuite connector exposes two columns for selects – one for the name and one for the value (often an Id). This does not work correctly if your saved search includes multiselect columns. There is nothing in the RESTlet metadata that distinguishes multiselect from single-select columns.
  </Step>

  <Step>
    Click **Save** to save the custom report.
  </Step>
</Steps>

### Limitations

* Currently, the NetSuite connector only supports RESTlets that conform to a response in the format of the included `search_script.js` script.
* The NetSuite connector does not support server side filtering on the results. To enable queries to execute faster, define all filters within the saved search itself.

## Saved Searches

Saved searches are supported with some limitations due to NetSuite restrictions.

<Note>
  **Note:** We recommend taking a look at RESTlets instead of following this guide. While these steps still work, saved searches used from SuiteTalk API as detailed below are limited both in how metadata can be obtained and content available. RESTlets have fewer limitations and return accurate metadata from NetSuite.
</Note>

### SavedSearches View

The SavedSearches view is a good way to retrieve a list of your available saved searches for a given search type. A SearchType must be specified to retrieve information from the SavedSearches view. For instance:

`SELECT * FROM SavedSearches WHERE SearchType='Transaction'`

### Add a Custom Report

<Steps>
  <Step>
    In the **Sources** page of Connect AI, select your NetSuite connection.
  </Step>

  <Step>
    Click the **Custom Reports** tab and click **Add** to add a new report.
    An **Add Custom Report** dialog appears.
  </Step>

  <Step>
    Select **SavedSearchSchema** and click **Confirm**.
  </Step>

  <Step>
    Enter the following information:

    * **Name**—the name of the custom report.
    * **SavedSearch**—the name of the saved search. This becomes the name of the resulting table.
    * **SavedSearchId**—the Id of the saved search.
    * **SearchType**—the type of search for the custom report. Click for a list of search types.
    * **ResultsToSample**—(optional) an integer designating the number of results to sample.
  </Step>

  <Step>
    Click **Save** to save the custom report.
  </Step>
</Steps>

### Limitations

NetSuite imposes a few limitations on saved searches. Calculated columns (formulas) cannot be retrieved via the NetSuite API. Only columns directly from the table can be retrieved. If you have a calculation in your saved search, you would need to return each individual column used in the calculation and perform the calculation client side. Ie:

`SELECT (col1 / col2) AS calc FROM MySavedSearch`

Saved searches that return an aggregation or summary (Group / Count / Sum / Minimum / Maximum / Average) cannot be returned at all. The NetSuite API throws an exception upon attempting to retrieve these saved searches. Due to this limitation, these saved searches are unavailable for our and any other third party tool.

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# NetSuite SuiteAnalytics
Source: https://docs.cloud.cdata.com/en/Data-Sources/NetSuiteSuiteAnalytics-Embedded



## Setup Guide

Follow these steps to connect NetSuite SuiteAnalytics to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *NetSuite SuiteAnalytics* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Server**—the host name or IP address of the server.
    * **AccountId**—the company account your username is associated with on NetSuite.
    * **RoleId**—the InternalId of the role that is used to log in to NetSuite. Obtain the RoleId by logging in to NetSuite and navigating to **Setup** > **Integration** > **Web Services Preferences**. The RoleId is displayed next to the specified role.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the NetSuite SuiteAnalytics username for authentication
        * **Password**—the user password
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the following information:

        * **Consumer Key**—The consumer key for the integration record. This string was created when you created the integration record.
        * **Consumer Secret**—The consumer secret for the integration record. This string was created when you created the integration record.
        * **TokenKey**—The token key used to authenticate requests to the data source.
        * **TokenSecret**—The token secret used to authenticate requests to the data source.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Advanced Settings Tab

### Authentication

Optionally, enter any **Native Driver Properties** in the **Advanced Settings** tab. These are any extra NetSuite SuiteAnalytics properties you want to add to the connection string, along with the other properties from the **Basic Settings** tab.

## Troubleshooting

<Accordion title="Failed to retrieve data">
  If the error contains no further information, and you can reproduce the error, you need to contact NetSuite support.
</Accordion>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# NetSuite Troubleshooting
Source: https://docs.cloud.cdata.com/en/Data-Sources/NetSuiteTroubleshooting-Embedded

The following are common issues with the NetSuite connection, and suggestions on how to solve them.

## General Troubleshooting

### Performance Considerations

If you find NetSuite to be too slow, you can try the following to improve performance:

* **Limit selected columns**
  <p>NetSuite objects rely heavily on backend JOINs. Removing unused columns can eliminate entire JOINs and significantly improve performance.</p>

* **Reduce page size**
  <p>Lowering the **Pagesize** property returns fewer records per request and can help avoid timeouts before all the results are returned. This property is found in **Edit NetSuite Connection** > **Advanced Settings**. </p>

* **Caching**
  <p>You should also consider using the Connect AI [Caching](/en/Caching) feature for better performance.</p>

### Schema Support and Performance

In general, performance is best in [SuiteAnalytics](/en/Data-Sources/NetSuiteSuiteAnalytics). Connect AI exposes CData's NetSuite driver as well as NetSuite’s native SuiteAnalytics driver as separate connectors. We recommend using the native SuiteAnalytics driver, if your organization has access to it, for best performance. If you do not have access to SuiteAnalytics, use the CData's NetSuite driver.

### Manage Integrations Visibility

To see **Setup** > **Integrations** > **Manage Integrations** in NetSuite, the role must have both of these permissions:

* **Integration Application (Full)** under **Setup**.

* **Integration Applications (Full)** under **Lists**.

See [Permissions Configurations](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_permissions) for more information.

## Common Errors

### SuiteQL Errors

<Accordion title="Unable to retrieve columns for a table (or Invalid search query).">
  This issue is usually a permissions issue to access the object type when using the SuiteQL schema. Note that permissions could apply to either the table or any of the columns in the table. The driver attempts to do a RowScan to determine which fields are available.

  Check your NetSuite role to see if the table is included:

  1. Log in to your NetSuite account as an administrator.
  2. Navigate to **Setup** > **Users/Roles** > **Manage Roles**.
  3. Select the role you are using to connect with the driver.
  4. Click **Edit** > **Permissions**.
  5. Under **Setup**, add **Full** permissions for the table you need.

  View the complete list of permissions required by our driver [here](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_permissions).

  In some cases, the table may have been deprecated or removed by NetSuite. Check whether another table exposes the same data.
</Accordion>

<Accordion title="Column not found">
  * If Connect AI cannot find a column, it may be due to cached or outdated metadata. Clear the metadata cache, if applicable, by clicking **Clear Metadata** on the **Edit NetSuite Connection** page.
  * It is also possible that the **RowScanDepth** property is zero. In that case, increase the **Row Scan Depth** property in the **Advanced Settings** tab of the **Edit NetSuite Connection** page to a non-zero value.
</Accordion>

<Accordion title="Missing rows">
  The SuiteQL schema can only return a maximum of 100,000 records. This limitation is imposed by NetSuite itself. You can bypass this limitation in one of two ways:

  * Set your Schema to SuiteTalk rather than Suite QL.

  * Use the SuiteAnalytics Connect feature. If your account has SuiteAnalytics Connect, enable the SuiteAnalytics Connect feature by setting the **AccountSupportsSuiteAnalyticsConnect** property to True.
</Accordion>

<Accordion title="Custom field not found">
  If you receive this error, you have not set the required **Custom Fields** permissions in NetSuite. See [Permissions Configurations](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_permissions).
</Accordion>

### SuiteTalk Errors

<Accordion title="Missing custom record types permission">
  Adjust the permissions for custom records. See [Permission Configurations](https://cdn.cdata.com/help/DNM/cloud/default.htm#pg_permissions).
</Accordion>

<Accordion title="Your role does not support OAuth2 login, please select a different one">
  This error appears when the role that you select during OAuth login is not configured for OAuth. If you have an OAuth-configured role, click **Choose another role** on the NetSuite authorization page and select that role. If you do not have an OAuth-configured role, follow the steps in the [Configure Roles](/en/Data-Sources/NetSuite#configure-roles) section.
</Accordion>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# OData
Source: https://docs.cloud.cdata.com/en/Data-Sources/OData-Embedded



## Setup Guide

Follow these steps to connect OData to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *OData* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="None">
    **None** is when no authentication is required.

    <Steps>
      <Step>
        Enter the following information:

        * **URL**—the root URL of the OData service (for example, `http://MySite/*MyOrganization*`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    **AzureAD** is a form of OAuth that goes through Azure.

    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant that you use to access data. If you leave this field blank, the account's default tenant is used.
        * **OAuth Client Id**—assigned when you registered your OData account for OAuth.
        * **OAuth Client Secret**—for your OData account for OAuth.
        * **URL**—the root URL of the OData service (for example, `http://MySite/*MyOrganization*`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    **Basic** is basic user name and password authentication.

    <Steps>
      <Step>
        Enter the following information:

        * **User**—the user name for the OData service.
        * **Password**—the password for the OData service.
        * **URL**—the root URL of the OData service (for example, `http://MySite/*MyOrganization*`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—assigned when you registered your OData account for OAuth.
        * **OAuthClient Secret**—for your OData account for OAuth.
        * **OAuth Authorization URL**—(optional) the URL where the user logs into the service.
        * **OAuth Access Token URL**—(optional) the URL where the request for the access token is made.
        * **OAuth Refresh Token URL**—(optional) the URL where refresh tokens can be exchanged for access tokens when old access tokens expire.
        * **URL**—the root URL of the OData service (for example, `http://MySite/*MyOrganization*`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SharePointOnline">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—your SharePoint Online user account.
        * **Password**—your SharePoint password.
        * **URL**—the root URL of the OData service (for example, `http://MySite/*MyOrganization*`).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and OData, see [this information page](https://cdn.cdata.com/help/RDM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Odoo
Source: https://docs.cloud.cdata.com/en/Data-Sources/Odoo-Embedded



## Prerequisites

Connect AI may be able to detect the Odoo database name automatically from the web address. However, we recommend that you specify the name of the Odoo database and enter it in the **Database** field.

To find your Odoo database name:

<Steps>
  <Step>
    Log in to your Odoo Online account.
  </Step>

  <Step>
    Click your profile icon in the top-right corner and select **My Databases**. Your database name is listed in the table.
  </Step>
</Steps>

Alternatively, you can often see the database name in the subdomain of your URL. If your URL is `https://mycompany.odoo.com`, your database name is likely `mycompany`.

## Setup Guide

Follow these steps to connect Odoo to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Odoo* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the base **URL** of the Odoo site to which you are connecting (for example, `http://my.odoo.com`).
  </Step>

  <Step>
    Enter the Odoo username for authentication in the **User** field.
  </Step>

  <Step>
    Enter the **API Token** used to authenticate the user.
  </Step>

  <Step>
    (Optional but recommended) Enter the name of the Odoo **Database** to which you are connecting. The prerequisites explain how to find the database name.
  </Step>

  <Step>
    (Optional) Set **Check Permissions** to `False` to allow a user without permission to `ir.model.access` to access all models as tables.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Odoo, see [this information page](https://cdn.cdata.com/help/OEM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Office 365
Source: https://docs.cloud.cdata.com/en/Data-Sources/Office365-Embedded



## Setup Guide

Follow these steps to connect Office 365 to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Office 365* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Office 365 sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Office 365 account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter your **OAuth Client Id**. This is in your Entra ID (formerly Azure AD) application settings.
      </Step>

      <Step>
        (Optional) Enter a **OAuthClientSecret**. This is in your Entra ID (formerly Azure AD) application settings.
      </Step>

      <Step>
        (Optional) Set the **OAuthJWTCert:** to the JWT certificate. This is a multi-line key.
        You must provide either an OAuth Client Secret OR OAuth JWT Cert to authenticate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Office 365, see [this information page](https://cdn.cdata.com/help/CXM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Okta
Source: https://docs.cloud.cdata.com/en/Data-Sources/Okta-Embedded



## Setup Guide

Follow these steps to connect Okta to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Okta* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Okta **Domain**. When logged into your Okta account, your domain is included in the URL. For example, in the URL `https://dev-44876464.okta.com/enduser/settings`, the domain is 'dev-44876464.okta.com'.
  </Step>

  <Step>
    Enter the **OAuth Client Id** assigned when you registered for OAuth. This Id registers the custom application with the OAuth authorization server.
  </Step>

  <Step>
    Enter the **OAuth Client Secret** for your Okta account. This secret registers the custom application with the OAuth authorization server.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth JWT">
    <Steps>
      <Step>
        Enter the **OAuth JWT Cert** provided by Okta. This is a multi-line key.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type** from the drop-down list. This is the type of key store containing the JWT certificate.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft OneDrive
Source: https://docs.cloud.cdata.com/en/Data-Sources/OneDrive-Embedded



## Setup Guide

Follow these steps to connect Microsoft OneDrive to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft OneDrive* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Azure Tenant**—(optional) the Microsoft OneDrive tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
    * **Default Groups**—the default group context when accessing group-scoped resources. The default is *AllGroups*.
    * **Default User**—the default user context when accessing user-scoped resources. The default is *CurrentUser*.
    * **Group Id**—(optional) the Id of a Microsoft OneDrive group whose data you want to access.
    * **User Id**—(optional) the Id of a Microsoft OneDrive user whose data you want to access.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Microsoft OneDrive sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Microsoft OneDrive account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client ID assigned when you registered your custom OAuth application.
        * **OAuth Client Secret**—the client secret assigned to your custom OAuth application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your custom OAuth application.
        * **OAuth JWT Cert**—the name of the client certificate's JWT Certificate store. This is a multi-line key.
        * **OAuth JWT Cert Type**—the type of key store containing the JWT Certificate.
        * **OAuth JWT Cert Password**—the password for the OAuth JWT certificate used to access a password-protected certificate store.
        * **OAuth JWT Cert Subject**—the subject of the OAuth JWT certificate used to locate a matching certificate in the store.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft OneDrive, see [this information page](https://cdn.cdata.com/help/UOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Microsoft OneNote
Source: https://docs.cloud.cdata.com/en/Data-Sources/OneNote-Embedded



## Setup Guide

Follow these steps to connect Microsoft OneNote to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Microsoft OneNote* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        (Optional) Enter **OAuth Client Id** in your application settings (if you are not using embedded credentials).
      </Step>

      <Step>
        (Optional) Enter your **OAuth Client Secret** (if you are not using embedded credentials).
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Microsoft OneNote sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Microsoft OneNote account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft OneNote account.
        * **OAuth Client Secret**—the client secret for your Microsoft OneNote account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant being used to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Microsoft OneNote account.
        * **OAuth JWL Cert**—the contents of the JWT certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Microsoft OneNote, see [this information page](https://cdn.cdata.com/help/UNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle Financials Cloud
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleERP-Embedded



## Setup Guide

Follow these steps to connect Oracle Financials Cloud to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle Financials Cloud* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Password**—the user password
    * **User**—the Oracle Financials Cloud username for authentication
    * **URL**—the URL to connect to, typically the URL of the Oracle Cloud Service. It is often in the format of [https://servername.fa.us2.oraclecloud.com](https://servername.fa.us2.oraclecloud.com).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle Eloqua
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleEloqua-Embedded



## Setup Guide

Follow these steps to connect Oracle Eloqua to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle Eloqua* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **Company** name on the Oracle Eloqua account.
      </Step>

      <Step>
        Enter the Oracle Eloqua username for authentication in the **User** Field.
      </Step>

      <Step>
        In **Password**, enter the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter your **OAuth Client Id**.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for that Id.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Oracle Eloqua sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your Oracle Eloqua account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Oracle Eloqua, see [this information page](https://cdn.cdata.com/help/DUM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle HCM Cloud
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleHCM-Embedded



## Setup Guide

Follow these steps to connect Oracle HCM Cloud to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle HCM Cloud* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Password**—the user password
    * **User**—the Oracle HCM Cloud username for authentication
    * **URL**—the URL of the account to connect to
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Oracle HCM Cloud, see [this information page](https://cdn.cdata.com/help/KMM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleOci-Embedded



## Setup Guide

Follow these steps to connect Oracle to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Connection String**. Copy one of the high, medium, or low connection strings available for your Oracle Autonomous Database, located in the **Database Connection** menu of the Oracle Autonomous Database. The string should be in the format shown. You can also connect to an Oracle self-hosted database.
  </Step>

  <Step>
    Enter the **User** and **Password** for the Oracle Autonomous Database.
  </Step>

  <Step>
    Click **Choose File** to upload the Oracle Wallet SSO file, `cwallet.sso`, found in the Oracle Wallet zip file. To download the Oracle Wallet zip file, go to the **Database Connection** menu in the Oracle Autonomous Database. This file is optional for an Oracle self-hosted database.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Oracle OCI, see [this information page](https://cdn.cdata.com/help/SOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle SCM
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleSCM-Embedded



## Setup Guide

Follow these steps to connect Oracle SCM to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle SCM* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Password**—the user password
    * **User**—the Oracle SCM username for authentication
    * **URL**—the URL of the account to connect to
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Oracle SCM, see [this information page](https://cdn.cdata.com/help/KSM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle Sales
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleSalesCloud-Embedded



## Setup Guide

Follow these steps to connect Oracle Sales to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle Sales* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the Oracle Sales server **Host URL** used for logging in.
  </Step>

  <Step>
    Enter the Oracle Sales username for authentication in the **Username** field.
  </Step>

  <Step>
    In the **Password** field, enter the user password.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Oracle Sales, see [this information page](https://cdn.cdata.com/help/EOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Oracle Service Cloud
Source: https://docs.cloud.cdata.com/en/Data-Sources/OracleServiceCloud-Embedded



## Setup Guide

Follow these steps to connect Oracle Service Cloud to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Oracle Service Cloud* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **URL**—the URL of the account to connect to
    * **User**—the Oracle Service Cloud username for authentication
    * **Password**—the user password
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Oracle Service Cloud, see [this information page](https://cdn.cdata.com/help/KOM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Outreach
Source: https://docs.cloud.cdata.com/en/Data-Sources/Outreach-Embedded



## Setup Guide

Follow these steps to connect Outreach to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Outreach* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Outreach sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Outreach account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Outreach, see [this information page](https://cdn.cdata.com/help/KRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PCA Accounting
Source: https://docs.cloud.cdata.com/en/Data-Sources/PCAAccounting-Embedded



## Setup Guide

Follow these steps to connect PCA Accounting to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PCA Accounting* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Data Center** name for the PCA API server. For example, *west01*, *east02*, *west03*, *east04*, *aws*.
  </Step>

  <Step>
    Specify the **Default Data Area**, or the first connected Data Area. For example, *P20V01C081KON0001*.
  </Step>

  <Step>
    Specify the **API Version** to use. The default is `V1`.
  </Step>

  <Step>
    Select the **Product Code** of the PCA product to which you want to connect. The options are **Acc20**, **Kon20**, or **SAcc20**.
  </Step>

  <Step>
    Select the **Auth Scheme**, then follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the PCA Accounting sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your PCA Accounting account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the PCA Accounting username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Enter the **Service Id** used to connect to the PCA API server.
      </Step>

      <Step>
        Enter the **Service Password** for the above Service Id.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and PCA Accounting, see [this information page](https://cdn.cdata.com/help/OKM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PCA Sales
Source: https://docs.cloud.cdata.com/en/Data-Sources/PCASales-Embedded



## Setup Guide

Follow these steps to connect PCA Sales to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PCA Sales* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Data Center** name for the PCA API server.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Specify the **Default Data Area** to which you want to connect.
      </Step>

      <Step>
        Select the **Product Code** of the PCA to which you want to connect. The options are `Kon20` or `Acc20`.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the PCA Sales sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your PCA Sales account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the PCA Sales username for authentication in the **User** field.
      </Step>

      <Step>
        In the **Password** field, enter the user password.
      </Step>

      <Step>
        Enter the **Service Id** used to connect to the PCA API server.
      </Step>

      <Step>
        Enter the **Service Password** for the above Service Id.
      </Step>

      <Step>
        Specify the **Default Data Area** to which you want to connect.
      </Step>

      <Step>
        Select the **Product Code** of the PCA to which you want to connect. The options are `Kon20` or `Acc20`.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and PCA Sales, see [this information page](https://cdn.cdata.com/help/OPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PayPal
Source: https://docs.cloud.cdata.com/en/Data-Sources/PayPal-Embedded



## Setup Guide

Follow these steps to connect PayPal to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PayPal* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select the **Schema** from the drop down list, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

### REST

<Steps>
  <Step>
    Enter the **OAuth Client Id** assigned when you registered your PayPal account for OAuth.
  </Step>

  <Step>
    Enter the **OAuth Client Secret** for your PayPal account.
  </Step>

  <Step>
    Set the **Use Sandbox** field to **True** only if you are using a sandbox account. Otherwise, leave it as **False**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

### SOAP

<Steps>
  <Step>
    Enter the PayPal username for authentication in the **User** field.
  </Step>

  <Step>
    In the **Password** field, enter the user password.
  </Step>

  <Step>
    Enter your **Signature**. To create a signature, in your PayPal business account navigate to **Profile** > **My Setting Tools**. In the API Access section click **Update**, and then **Request API Credentials** on the following page.
  </Step>

  <Step>
    Set the **Use Sandbox** field to **True** only if you are using a sandbox account. Otherwise, leave it as **False**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and PayPal, see [this information page](https://cdn.cdata.com/help/BPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Paylocity
Source: https://docs.cloud.cdata.com/en/Data-Sources/Paylocity-Embedded



## Prerequisites

Before you can authenticate to Paylocity via OAuth, you must first obtain API access and register your desired callback URL with Paylocity. The callback URL for Connect AI is *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.

To register, contact either [service@paylocity.com](mailto:service@paylocity.com) or [sales@paylocity.com](mailto:sales@paylocity.com).

Once your access has been reviewed and approved, Paylocity provides you with OAuth credentials and access to either a Sandbox or a Production account. This access is necessary for authenticating your API requests.

Paylocity provides the following OAuth credentials.

* **client\_id**: The client\_id assigned to the registered OAuth application in the Paylocity developer portal. This value is used to set the **OAuthClientId**.
* **secret**: The secret assigned to the registered OAuth application in the Paylocity developer portal. This value is used to set the **OAuthClientSecret**. Note that Paylocity requires secrets to be rotated every 365 days. They send an email reminder of your secret expiring at 10 days before expiration and again at 5 days before expiration.

## Setup Guide

Follow these steps to connect Paylocity to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Paylocity* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **OAuth Client Id**–set to the client Id obtained in the prerequisites.
    * **OAuth Client Secret**—set to the client secret obtained in the prerequisites.
    * **RSA Public Key**—the RSA key associated with your Paylocity account. Only required if you want to execute Insert and Update statements.
    * **Key**—set this to the Base64-encoded AES symmetric key to use when encrypting content. Only required if the IV is set.
    * **IV**—set this to the Base64-encoded AES initialization vector (IV) to use when encrypting content. Only required if Key is also set.
    * **Authentication Model**–select how you want other users to access the data to this data source, either with shared authentication or with the user's own credentials (per-user authentication).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Paylocity, see [this information page](https://cdn.cdata.com/help/KPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PingOne
Source: https://docs.cloud.cdata.com/en/Data-Sources/PingOne-Embedded



## Prerequisites

Complete these steps to create a custom OAuth application before configuring the connection:

<Steps>
  <Step>
    Sign in to your PingOne organization's admin console with your administrator account. Your organization's home page displays.
  </Step>

  <Step>
    In the left navigation pane, click **Environments**. A list of environments displays.
  </Step>

  <Step>
    Click the environment where you want your custom OAuth application to reside. (This should be the Administrators environment.) Note the environment ID. The is the value you enter as the **Worker App Environment Id** in Connect AI.
  </Step>

  <Step>
    Click **Manage Environment**. The home page of the environment you chose displays.
  </Step>

  <Step>
    In the left navigation pane, click **Applications**.
  </Step>

  <Step>
    Click the **+** button at the top left corner of the page. The console displays the New Application form.
  </Step>

  <Step>
    Provide an **Application Name** for the custom OAuth application.
  </Step>

  <Step>
    Set **Application Type** to **Worker**.
  </Step>

  <Step>
    Click **Save**. The console displays the Application Details for your new custom OAuth application. Note the **Client ID** and **Client Secret**. You enter them in the steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect PingOne to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PingOne* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Worker App Environment Id**, which is the ID of the PingOne environment in which your application resides.
  </Step>

  <Step>
    Select the **Region** where your PingOne organization data is hosted.
  </Step>

  <Step>
    (Optional) Specify a **Schema** to use. The available schemas are **Information** and dynamic environment schemas (one for each environment in your PingOne organization).
  </Step>

  <Step>
    Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the prerequisites.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the PingOne sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your PingOne account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** and **OAuth Client Secret** obtained from the prerequisites.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Pinterest
Source: https://docs.cloud.cdata.com/en/Data-Sources/Pinterest-Embedded



## Prerequisites

Pinterest requires a custom OAuth application to connect. Before you begin, create an application in the Pinterest developer portal to obtain an **OAuth Client Id** and **OAuth Client Secret**:

<Steps>
  <Step>
    Navigate to the [Pinterest developer portal](https://developers.pinterest.com/apps/) and sign in with your Pinterest credentials.
  </Step>

  <Step>
    Click **Create app**.
  </Step>

  <Step>
    Specify an app **Name** and **Description**, then click **Create**.
  </Step>

  <Step>
    In the app settings, locate the **Redirect URIs** section and enter the redirect URI used by Connect AI: *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Save your changes, then select **View Client ID** to display your **Client ID** and **Client Secret**. These are the values you enter as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Pinterest to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Pinterest* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **OAuth Client Id**—the client ID assigned to your custom OAuth application.
    * **OAuth Client Secret**—the client secret assigned to your custom OAuth application.
    * **Ad Account Id**—(optional) the unique identifier of an Ad Account. If omitted, Connect AI selects the first Ad Account configured for the account.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Pinterest sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Pinterest account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Pinterest, see [this information page](https://cdn.cdata.com/help/UPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Pipedrive
Source: https://docs.cloud.cdata.com/en/Data-Sources/Pipedrive-Embedded



## Setup Guide

Follow these steps to connect Pipedrive to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Pipedrive* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **Company Domain** used for accessing your Pipedrive account. This is visible in the URL of your Developer Sandbox account.
  </Step>

  <Step>
    Enter the **Schema** to use, API V1 or V2. **Note:** The V2 API is in a beta phase.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **API Token** used for accessing your Pipedrive account.
        To obtain an API Token, do the following:

        1. Open the Pipedrive portal.

        2. At the top right corner of the page, click the account name. Pipedrive displays a drop-down list.

        3. Navigate to **Company Settings** > **Personal Preferences** > **API** > **Generate Token**.

        4. Record the value of the generated API token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—the client Id assigned when you registered your Pipedrive account for OAuth.
        * **OAuth Client Secret**—the client secret assigned when you registered your Pipedrive account for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# PostgreSQL
Source: https://docs.cloud.cdata.com/en/Data-Sources/PostgreSQL-Embedded



## Prerequisites

#### Whitelist CData IPs

To establish a connection to PostgreSQL, you need to allow access to PostgreSQL via CData’s IP. When hosting PostgreSQL behind a firewall, you must safelist these IP addresses in your firewall.

* Range: `52.224.0.160` to `52.224.0.175` and `4.154.117.160` to `4.154.117.175`.
* CIDR notation: `52.224.0.160/28` and `4.154.117.160/28`

#### Ensure PostgreSQL Is Publicly Accessible

Provide a public facing IP/domain to connect to this data source. The following private IP ranges do not work:

* `10.0.0.0` to `10.255.255.255`
* `172.16.0.0` to `172.31.255.255`
* `192.168.0.0` to `192.168.255.255`
* `127.0.0.1` (aka ‘localhost’)

## Setup Guide

Follow these steps to connect PostgreSQL to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *PostgreSQL* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    If your PostgreSQL connection is behind a firewall, set the **Connection Type** to **SSH Tunnel** and follow the instructions in [SSH Tunnel Instructions](#ssh-tunnel-instructions). Then continue with these instructions. Otherwise, leave the **Connection Type** as **Direct**.
  </Step>

  <Step>
    In the **Server** field, enter the host name or IP address of the PostgreSQL server.
  </Step>

  <Step>
    <Note>
      **Note:** If your PostgreSQL database has a self-signed certificate, you must copy the self-signed certificate into the **Advanced Settings** > **SSL Server Cert** field.
    </Note>
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        In the **User** field, enter the PostgreSQL username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        (Optional) Enter the name of the PostgreSQL **Database**. If none is entered, the user's default database is used.
      </Step>

      <Step>
        (Optional) Specify the port for connecting to the PostgreSQL server in the **Port** field. This is set to 5432 by default.
      </Step>

      <Step>
        In PostgreSQL, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        In the **User** field, enter the PostgreSQL username for authentication.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        (Optional) Enter the name of the PostgreSQL **Database**. If none is entered, the user's default database is used.
      </Step>

      <Step>
        (Optional) Specify the port for connecting to the PostgreSQL server in the **Port** field. This is set to 5432 by default.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the PostgreSQL sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your PostgreSQL account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        In PostgreSQL, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzurePassword">
    <Steps>
      <Step>
        In the **User** field, enter the PostgreSQL username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        Enter the **Azure Tenant** Id to connect to.
      </Step>

      <Step>
        (Optional) Enter the name of the PostgreSQL **Database**. If none is entered, the user's default database is used.
      </Step>

      <Step>
        (Optional) Specify the port for connecting to the PostgreSQL server in the **Port** field. This is set to 5432 by default.
      </Step>

      <Step>
        In PostgreSQL, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AWSIAMRoles">
    <Steps>
      <Step>
        In the **User** field, enter the PostgreSQL username for authentication.
      </Step>

      <Step>
        Enter the **AWS Access Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Secret Key** associated with the AWS root account.
      </Step>

      <Step>
        Enter the **AWS Role ARN** for the authenticating User Id.
      </Step>

      <Step>
        (Optional) Enter the **AWS External Id** only if emulating a different role.
      </Step>

      <Step>
        (Optional) Enter the name of the PostgreSQL **Database**. If none is entered, the user's default database is used.
      </Step>

      <Step>
        (Optional) Specify the port for connecting to the PostgreSQL server in the **Port** field. This is set to 5432 by default.
      </Step>

      <Step>
        In PostgreSQL, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## SSH Tunnel Instructions

If your PostgreSQL data source is behind a firewall, follow these instructions.

<Steps>
  <Step>
    Click **Connection Type** of **SSH Tunnel**.
  </Step>

  <Step>
    Enter the following information:

    * **SSH Server**–enter the name of the SSH server.
    * **SSH Port**–enter the SSH port. The default value is 22.
    * **SSH Auth Mode**–enter the authentication mode of **Password** or **Public\_Key**.
      * If **Password**, enter the **SSH User** name and **SSH Password**.
      * If **Public\_Key**, enter the **SSH User** name, **SSH Client Cert**, and **SSH Client Cert Password** (optional). Only PEMKEY\_BLOB is available as the **SSH Client Cert Type**. The **SSH Client Cert** is required, and is a valid private key. Enter the **SSH Client Cert Password** if the SSH client certificate has a password.
  </Step>

  <Step>
    Continue with the authentication instructions in the [Setup Guide](#setup-guide).
  </Step>
</Steps>

## Private Cloud Connector Connection

PostgreSQL is a supported connector with Private Cloud Connector, which acts as a bridge between your on-premises data and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information. Once you set up the gateway, you can select the **Connection Type** of **Private Cloud Connector**. Then enter **Location Name** of the gateway and the PostgreSQL authentication information.

## More Information

For more information about interactions between Connect AI and PostgreSQL, see [this information page](https://cdn.cdata.com/help/FPM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Power BI XMLA
Source: https://docs.cloud.cdata.com/en/Data-Sources/PowerBIXMLA-Embedded



## Setup Guide

Follow these steps to connect Power BI XMLA to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Power BI XMLA* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Power BI XMLA sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Power BI XMLA account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Power BI XMLA, see [this information page](https://cdn.cdata.com/help/LGJ/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Presto
Source: https://docs.cloud.cdata.com/en/Data-Sources/Presto-Embedded



## Setup Guide

Follow these steps to connect Presto to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Presto* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **User**—the Presto username for authentication
    * **Password**—the user password
    * **Port**—the port for connecting to the Presto server
    * **Server**—the host name or IP address of the Presto REST server
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and Presto, see [this information page](https://cdn.cdata.com/help/ORM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Quickbase
Source: https://docs.cloud.cdata.com/en/Data-Sources/QuickBase-Embedded



## Setup Guide

Follow these steps to connect Quickbase to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Quickbase* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        For Basic authentication, enter the following information:

        * **User**—the Quickbase username for authentication.
        * **Password**—the user password.
        * **Application Token**—(optional) the application token is located at **MyAppName** > **Settings** > **App properties** > **Advanced settings** > **Security options** > **Require Application Tokens** > **Manage Application Token**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the **User Token**. You can find the User Token under **Quickbase** > **My Preferences** > **My User Information** > **Manage User Tokens**.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Quickbase, see [this information page](https://cdn.cdata.com/help/GUM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# QuickBooks
Source: https://docs.cloud.cdata.com/en/Data-Sources/QuickBooks-Embedded



## Prerequisites

Because the QuickBooks Gateway runs on your local machine, you must also do the following:

* Set up the Private Cloud Connector on the same network as your QuickBooks machine. This allows Connect AI to reach the local machine. The Private Cloud Connector acts as a secure tunnel between your on-premises network and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information.
* Install and configure the CData QuickBooks Gateway on the machine that hosts QuickBooks Desktop as follows:

<Steps>
  <Step>
    [Download](https://www.cdata.com/products/quickbooksgateway/) and install the CData QuickBooks Gateway on the machine where QuickBooks Desktop is installed.
  </Step>

  <Step>
    Launch QuickBooks Desktop and ensure that the company file you want to access is open.
  </Step>

  <Step>
    Start the QuickBooks Gateway. By default, it listens at [http://localhost:8166](http://localhost:8166).
  </Step>

  <Step>
    Note the **URL**, **User**, and **Password** configured in the QuickBooks Gateway. You will enter these in the setup steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect QuickBooks to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *QuickBooks* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Connection Type** of **Private Cloud Connector**.
  </Step>

  <Step>
    Select a **Location Name** of the gateway you created in the prerequisites.
  </Step>

  <Step>
    Enter the **URL** where the QuickBooks Gateway is running (for example, *[http://localhost:8166](http://localhost:8166)*). This is the endpoint the connector uses to communicate with QuickBooks Desktop. The **URL** you enter is resolved through the Private Cloud Connector tunnel.
  </Step>

  <Step>
    Enter the **User** and **Password** required to authenticate the connection to the QuickBooks Gateway.
  </Step>

  <Step>
    (Optional) Enter the **Application Name** of the application connecting to QuickBooks. The default value is *CData QuickBooks Connector*.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and QuickBooks, see [this information page](https://cdn.cdata.com/help/RQM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# QuickBooks Online
Source: https://docs.cloud.cdata.com/en/Data-Sources/QuickBooksOnline-Embedded



CData Connect AI includes embedded OAuth credentials for QuickBooks Online that simplify the connection process. With the embedded credentials, you can connect to QuickBooks Online without creating a custom OAuth application.

Note that the embedded OAuth credentials have limited functionality due to monthly query limits imposed by Intuit. If you exceed the monthly query limit, queries will return an error until the limit resets.

## Create a Custom OAuth Application

To avoid monthly query limits and experience full functionality, create a custom OAuth application in QuickBooks Online. This is recommended for production use or any scenario where you expect regular or high-volume queries.

To create a custom OAuth application in the Intuit Developer Portal, follow these steps:

<Steps>
  <Step>
    Log in to the Intuit Developer Portal.

    * Go to: [https://developer.intuit.com](https://developer.intuit.com/).
    * Sign in with your Intuit account (or create one if you don't already have one).
  </Step>

  <Step>
    Create a new app.

    * From the dashboard, open an existing **Workspace** or create a new one if you do not yet have one. In the **Workspace**, click the **+** button to create a new app.
  </Step>

  <Step>
    Set up app details.

    * The **Type** screen should automatically pick **QuickBooks Online and Payments**.
    * On the **Basic info** screen, provide a name for your application (for example, *CData QuickBooks Integration*).
    * On **Permissions**, select the **com.intuit.quickbooks.accounting** permission.
    * Click **Done** and **Confirm** the creation of your application. Afterwards, **Open** your application.
  </Step>

  <Step>
    Configure the redirect URI.

    * In the App Overview of your application, go to **Settings** > **Redirect URIs**. Click **Add URI** and add the following redirect URI (used by CData connectors): *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
    * **Save** the configuration.
  </Step>

  <Step>
    Set the Regulated Industries.

    * Go to **Settings** > **Regulated Industries**. Select **None of the above**, then **Save**.
    * This will shorten the questionnaire in the next step. Intuit recommends waiting 30 minutes after saving to ensure this takes effect.
  </Step>

  <Step>
    Submit the app assessment for production keys.

    * Intuit requires an assessment to be submitted for every application, even if it is used for internal use in your own company. In the App Overview, navigate to the **Compliance** tab. Click **Start questionnaire**.
    * You should only see two tabs: **General Questions** and **App Information**. If you see more than two tabs, please wait for Step 5 to take effect.
    * Under **General Info**, answer all the questions as per your organization's specifications.
    * Under **App Information**, select **You were asked to create this app in order to get credentials/keys to be used on another platform that integrates with QuickBooks** for question 1. Provide the following link: *[https://www.cdata.com/drivers/qbonline/](https://www.cdata.com/drivers/qbonline/)*.
    * Click **Submit** once you are done and wait to receive the **Application Assessment - Questionnaire Completed** email.
  </Step>

  <Step>
    Retrieve your credentials.

    * Once Intuit has approved your application, copy the **Client ID** and **Client Secret** generated for your app from the **Keys and Credentials** > **Production** section of the App Overview. You enter these values in the setup steps below.
  </Step>
</Steps>

## Setup Guide

<Note>Each connection to QuickBooks Online can only connect to one company.</Note>

Follow these steps to connect QuickBooks Online to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *QuickBooks Online* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set **Use Sandbox** to **True** only if you are using a sandbox account. Otherwise, leave it as **False**.
  </Step>

  <Step>
    Select the **Country Code** that best matches your location.
  </Step>

  <Step>
    If you are using a custom OAuth application, click **Advanced Settings** and enter the **Client Id** and **Client Secret** obtained from the prerequisites.
  </Step>

  <Step>
    If you are using embedded credentials, click **Sign in** to connect using those credentials. This action opens the QuickBooks Online sign-in page in a new tab.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## Common Queries

The **Data Model** tab, in addition to the QuickBooks Online data model, contains a list of common queries used for QuickBooks Online. Expand **Common Queries** to view the SQL query templates, such as **Customer Outstanding Balances Report**. Click the ellipsis next to the query title and click **Execute Query**.

<Frame>
  <img alt="" />
</Frame>

The [Data Explorer](/en/Data-Explorer) screen appears, displaying the SQL query. From there, you can execute, edit, or save the query. You can also save the query as a derived view, so that you can access it from external integrations.

## More Information

For more information about interactions between Connect AI and QuickBooks Online, see [this information page](https://cdn.cdata.com/help/RNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# RSS
Source: https://docs.cloud.cdata.com/en/Data-Sources/RSS-Embedded



## Setup Guide

Follow these steps to connect RSS to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *RSS* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI**, which is the Uniform Resource Identifier of the feed.
  </Step>

  <Step>
    Select the **Auth Scheme** used for HTTP authentication. Accepted entries are **None**, **Basic**, **Digest**, **NTLM**, and **Negotiate**.
  </Step>

  <Step>
    (Optional) Enter the **Auth Token** used for authentication. This is required when **Auth Scheme** is set to any value other than **None**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and RSS, see [this information page](https://cdn.cdata.com/help/RRM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Reckon
Source: https://docs.cloud.cdata.com/en/Data-Sources/Reckon-Embedded



## Setup Guide

Follow these steps to connect Reckon to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Reckon* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication

<Steps>
  <Step>
    Enter your Reckon Gateway **User** and **Password**.
  </Step>

  <Step>
    Enter the **URL** where your Reckon Gateway is running (for example, *[http://localhost:8166](http://localhost:8166)*).
  </Step>

  <Step>
    (Optional) Enter an **Application Name** to identify this connection to Reckon. The default is *CData Reckon Connector*.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information on configuring the Reckon data source, see [this information page](https://cdn.cdata.com/help/BAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Reckon Accounts Hosted
Source: https://docs.cloud.cdata.com/en/Data-Sources/ReckonAccountsHosted-Embedded



## Setup Guide

Follow these steps to connect Reckon Accounts Hosted to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Reckon Accounts Hosted* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter your Reckon Accounts Hosted **User** name.
  </Step>

  <Step>
    Enter your Reckon Accounts Hosted **Password**.
  </Step>

  <Step>
    Enter the complete path of where your **Company File** is located, for example, *Q:/MyCompanyFile.qbw*. The company file usually has a `.qbw` or `.qba` extension.
  </Step>

  <Step>
    Enter the **Country Version** of Reckon Accounts Hosted, for example, *2018.R2.AU*.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the Reckon Accounts Hosted sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your Reckon Accounts Hosted account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Redis
Source: https://docs.cloud.cdata.com/en/Data-Sources/Redis-Embedded



## Setup Guide

Follow these steps to connect Redis to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Redis* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the host name or IP address of the **Server** hosting the Redis instance.
  </Step>

  <Step>
    Enter the port for connecting to the Redis server into **Port**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        In Redis, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ACL">
    <Steps>
      <Step>
        In the **User** field, enter the Redis username for authentication.
      </Step>

      <Step>
        Enter the user password in the **Password** field.
      </Step>

      <Step>
        In Redis, add the Connect AI static IP addresses to your connection whitelist.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Redis, see [this information page](https://cdn.cdata.com/help/EIM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# Rippling
Source: https://docs.cloud.cdata.com/en/Data-Sources/Rippling-Embedded



## Prerequisites

Before you can connect to Connect AI, you must generate an API token in Rippling.

<Steps>
  <Step>
    Go to [app.rippling.com](https://app.rippling.com) and sign in with your admin account.
  </Step>

  <Step>
    Navigate to the API Tokens app. You can find it by searching for *API Tokens*, navigating to **Settings**, or going directly to [app.rippling.com/api-tokens/](https://app.rippling.com/api-tokens/).
  </Step>

  <Step>
    Create a new API token by providing a name, a unique identifier, and selecting the API version.
  </Step>

  <Step>
    Configure the API permissions based on the required access. Select only the scopes your integration needs (for example, `workers.read`, `users.read`, `departments.read`).
  </Step>

  <Step>
    Copy and securely store the token value. It will not be displayed again.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Rippling to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Rippling* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of your Rippling endpoint (for example, *[https://rest.ripplingapis.com/](https://rest.ripplingapis.com/)*).
  </Step>

  <Step>
    Enter the **API Token** that you obtained in the prerequisites.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Ariba Procurement
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPAribaProcurement-Embedded



## Prerequisites

Before you can connect SAP Ariba Procurement, you must create a custom OAuth app as follows:

<Steps>
  <Step>
    Go to the [SAP Developer Portal](https://developer.ariba.com/) and sign in.
  </Step>

  <Step>
    Click **Manage** (bottom icon on the left).
  </Step>

  <Step>
    Click the **+** button next to the search field.
  </Step>

  <Step>
    Fill in **Application Name** and **Description**, and then click **Submit**.
  </Step>

  <Step>
    Click **Actions** > **Request API Access**.
  </Step>

  <Step>
    Select the API you want to retrieve data from. This corresponds to the API connection property.
  </Step>

  <Step>
    Select your realm.
  </Step>

  <Step>
    Click **Submit**. Wait until the request is approved.
  </Step>

  <Step>
    Once approved, click **Actions** > **Generate OAuth Secret**.
  </Step>

  <Step>
    Save the values displayed for **API key**, **OAuth Client Id**, and **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SAP Ariba Procurement to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Ariba Procurement* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **API Key**—the API key created in the prerequisites.
    * **API**—the API you want to retrieve data from.
    * **ANID**—your SAP Ariba Network Id. [Find your ANID as a buyer](https://support.ariba.com/item/view/187831) or [find your ANID as a supplier](https://support.ariba.com/item/view/KB0392438).
    * **OAuth Client Id**—the OAuth client Id from the prerequisites.
    * **OAuth Client Secret**—the OAuth client secret from the prerequisites.
    * **Max Threads**—the maximum number of concurrent requests the provider can execute to SAP Ariba.
    * **Environment**—the environment to use when connecting to SAP Ariba, either PRODUCTION or TEST.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Ariba Procurement, see [this information page](https://cdn.cdata.com/help/PAM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Ariba Sourcing
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPAribaSource-Embedded



## Prerequisites

Before you can connect SAP Ariba Sourcing, you must create a custom OAuth app as follows:

<Steps>
  <Step>
    Go to the [SAP Developer Portal](https://developer.ariba.com/) and sign in.
  </Step>

  <Step>
    Click **Manage** (bottom icon on the left).
  </Step>

  <Step>
    Click the **+** button next to the search field.
  </Step>

  <Step>
    Fill in **Application Name** and **Description**, and then click **Submit**.
  </Step>

  <Step>
    Click **Actions** > **Request API Access**.
  </Step>

  <Step>
    Select the API you want to retrieve data from. This corresponds to the API connection property.
  </Step>

  <Step>
    Select your realm.
  </Step>

  <Step>
    Click **Submit**. Wait until the request is approved.
  </Step>

  <Step>
    Once approved, click **Actions** > **Generate OAuth Secret**.
  </Step>

  <Step>
    Save the values displayed for **API key**, **OAuth Client Id**, and **OAuth Client Secret**.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SAP Ariba Sourcing to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Ariba Sourcing* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **API Key**—the API key created in the prerequisites.
    * **Realm**—the realm from which you want to access data.
    * **API**—the API you want to retrieve data from.
    * **Data Center**—the data center where your account's data is hosted.
    * **Type Detection Scheme**—select whether to return all columns as the string type (None) or scan rows to determine the data type (RowScan).
    * **Include Custom Fields**—toggle on to include custom fields from SAP Ariba tables.
    * **OAuth Client Id**—the OAuth client Id from the prerequisites.
    * **OAuth Client Secret**—the OAuth client secret from the prerequisites.
    * **Max Threads**—the maximum number of concurrent requests the provider can execute to SAP Ariba.
    * **Environment**—the environment to use when connecting to SAP Ariba, either PRODUCTION or TEST.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Ariba Sourcing, see [this information page](https://cdn.cdata.com/help/PBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Business Objects BI
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPBusinessObjectsBI-Embedded



## Setup Guide

Follow these steps to connect SAP Business Objects BI to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Business Objects BI* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Under **Authentication**, enter the **URL** of the REST API exposed by the SAP Business Objects BI. You can find the correct URL in the Central Management Console of SAP Business Objects BI. Select **Applications**, and then double-click **RESTful Web Service** to view the access URL. By default, it is `http://[SERVER-NAME]:6405/biprws`.
  </Step>

  <Step>
    Enter the SAP Business Objects BI schema to connect to:

    * **SAPBusinessObjectsBI**—exposes SAP Universes as views for direct querying and reporting.
    * **Administration**—includes views, tables, and procedures for admin-level operations.
    * **Reporting**—provides report-specific views, tables, and procedures.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the SAP Business Objects BI username for authentication.
        * **Password**—the user password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Enterprise">
    <Steps>
      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="LDAP">
    <Steps>
      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="WinAD">
    <Steps>
      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="CyberArk">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the SAP Business Objects BI username for authentication.
        * **Password**—the user password.
        * **SSO Login URL**—enter the SSO provider's login URL.
        * **SSO Properties**—enter any additional property-value pairs required to connect to the SSO provider, separated by semicolons.
        * **SSO Exchange Url**—enter the URL used for consuming the SAML response and exchanging it for service-specific credentials.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAP Business Objects BI, see [this information page](https://cdn.cdata.com/help/GJM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Business One
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPBusinessOne-Embedded



## Prerequisites

If your SAP Business One server is on a private network or behind a firewall, set up the Private Cloud Connector on the same network as your SAP Business One server. The Private Cloud Connector acts as a secure tunnel between your on-premises network and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information.

## Setup Guide

Follow these steps to connect SAP Business One to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Business One* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select a **Connection Type**:

    * Select **Direct** if your SAP Business One server is publicly accessible.
    * Select **Private Cloud Connector** if your SAP Business One server is on a private network or behind a firewall.
  </Step>

  <Step>
    (Private Cloud Connector only) Select the **Location Name** of the gateway you set up in the prerequisites.
  </Step>

  <Step>
    Enter the following information:

    * **Company DB**—the SAP Business One company database
    * **Password**—the user password
    * **User**—the SAP Business One username for authentication
    * **URL**—the URL to the SAP Business One service layer root, in the format `https://[IP-address]:[port]/b1s/[version]` (for example, `https://192.168.123.132:50000/b1s/v1`).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Business One, see [this information page](https://cdn.cdata.com/help/FVM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Business Warehouse
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPBusinessWarehouse-Embedded



## Setup Guide

Follow these steps to connect SAP Business Warehouse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Business Warehouse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** used to connect to the SAP Business Warehouse.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication

<Tabs>
  <Tab title="Basic">
    This method uses HTTP Basic authentication.

    <Steps>
      <Step>
        Enter the **User**, which is your SAP Business Warehouse user ID.
      </Step>

      <Step>
        Enter the **Password** for your SAP Business Warehouse account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Negotiate">
    This method negotiates an authentication mechanism with the server.

    <Steps>
      <Step>
        Enter the **User**, which is your SAP Business Warehouse user ID.
      </Step>

      <Step>
        Enter the **Password** for your SAP Business Warehouse account.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="None">
    <Steps>
      <Step>
        No additional settings are required for this authentication mode.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP ByDesign
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPByDesign-Embedded



## Setup Guide

Follow these steps to connect SAP ByDesign to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP ByDesign* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** to your system host name. This URL should conform to the following format: `https://my999999.businessbydesign.cloud.sap;`.
  </Step>

  <Step>
    Enter the SAP ByDesign username for authentication in the **User** field.
  </Step>

  <Step>
    In the **Password** field, enter the user password.
  </Step>

  <Step>
    Select the **Service Type** from `AnalyticsService`, `CustomService`, or `ODataDataSource`.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP ByDesign, see [this information page](https://cdn.cdata.com/help/UYM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Concur
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPConcur-Embedded



## Setup Guide

Follow these steps to connect SAP Concur to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Concur* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Create a custom OAuth application in SAP Concur.

    * You may need to contact your Partner Enablement Manager or Partner Account Manager for SAP Concur for this step.
    * Once the application is created, copy down your clientId and clientSecret.
  </Step>

  <Step>
    In Connect AI, select a region.
  </Step>

  <Step>
    Choose an **Auth Scheme**.

    * If you choose **OAuth**, enter the following information.
      * **OAuth Client Id**—your clientId from the custom OAuth application.
      * **OAuth Client Secret**—your clientSecret from the custom OAuth application.
    * If you choose **OAuthPassword**, enter the following information.
      * **Username**—the SAP Concur username for authentication.
      * **Password**—the user password.
      * **OAuth Client Id**—enter your clientId from the custom OAuth application.
      * **OAuth Client Secret**—enter your clientSecret from the custom OAuth application.
    * If you choose **CompanyLevelAuth**, enter the following information.
      * **CompanyId**—enter the unique identifier for your company.
      * **Company Request Token**—enter your company request token. To obtain one, use the Company Request Token tool, or contact SAP Concur support.
      * **OAuth Client Id**—your clientId from the custom OAuth application.
      * **OAuth Client Secret**—your clientSecret from the custom OAuth application.
  </Step>

  <Step>
    Click **Sign in** to connect securely through OAuth. This action opens the SAP Concur sign-in page in a new tab.
  </Step>

  <Step>
    Log in to your SAP Concur account and provide the requested permissions (if applicable).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Concur, see [this information page](https://cdn.cdata.com/help/FNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Fieldglass
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPFieldglass-Embedded



## Prerequisites

Please contact your SAP Fieldglass representative to obtain an Environment URL, OAuth Client Id, and OAuth Client Secret.

## Setup Guide

Follow these steps to connect SAP Fieldglass to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Fieldglass* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the following information:

    * **Environment URL**–the instance where SAP Fieldglass is located, for example, `https://myinstance.com`.
    * **OAuth Client Id**–the client Id assigned to your custom OAuth application.
    * **OAuth Client Secret**–the confidential client secret assigned to your custom OAuth Application.
    * **Connector Data Format**–the data format for downloaded data: CSV or JSON.
    * **APIKey**–(optional) the API key used to authenticate to SAP Fieldglass. If you encounter an error indicating that an API key is required, you can request one from SAP Fieldglass administration or log in to the SAP Fieldglass Integration Tools and click **Create API Application**.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Fieldglass, see [this information page](https://cdn.cdata.com/help/UFM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Gateway
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPGateway-Embedded



## Setup Guide

Follow these steps to connect SAP Gateway to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Gateway* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** for your SAP Gateway environment or the full URL of the OData service. Any additional properties must be added using **Custom URL Params**.
  </Step>

  <Step>
    (Optional) Enter the service **Namespace** you want to retrieve data from. This is only required if the service is not specified in the **URL**.
  </Step>

  <Step>
    (Optional) Enter the **Service**, which is a comma-delimited list of services you want to retrieve data from. If the service is set in the **URL**, this property is ignored. In cases where the service is not set in the URL or in **Service**, the SAP Gateway's catalog service is used to discover all available services.
  </Step>

  <Step>
    (Optional) Enter any **Custom URL Params** to be included with the HTTP request. The parameters should be in the form *field1=value1\&field2=value2\&field3=value3*.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **User** Id for the authenticating user.
      </Step>

      <Step>
        Enter the **Password** for the authenticating user.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned to your custom OAuth application. This Id is required to identify the application to the OAuth authorization server during authentication.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application. This value is used to authenticate the custom application to the OAuth authorization server.
      </Step>

      <Step>
        Enter the **Scope**, or permission scopes, in space separated values. Scopes define what kind of access the authenticating user has, such as read or read/write. Scopes are required for OAuth 2.0.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Token">
    <Steps>
      <Step>
        Enter the **API Key** of the application you have created.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Set authentication to **OAuthPKCE** to use the Proof Key of Code Exchange (PKCE) extension of the standard OAuth2 flow. Set your own PKCEVerifier or let the driver automatically generate one for you.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="SAPBTP">
    <Steps>
      <Step>
        In **Advanced Settings**, enter the **Destination URL** of the SAP BTP destination source. This URL is found in the service key of your Destination Service instance in the SAP BTP Cockpit, in the **URI** field.
      </Step>

      <Step>
        In **Advanced Settings**, enter the **Destination Name** of the SAP BTP destination to retrieve the authentication details from.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Private Cloud Connector Connection

SAP Gateway is a supported connector with Private Cloud Connector, which acts as a bridge between your on-premises data and Connect AI. See [Private Cloud Connector](/en/Private-Cloud-Connector) for more information. Once you set up the gateway, you can select the **Connection Type** of **Private Cloud Connector**. Then enter **Location Name** of the gateway and the SAP Gateway authentication information.

## More Information

For more information about interactions between Connect AI and SAP Gateway, see [this information page](https://cdn.cdata.com/help/GCM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP HANA
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPHANA-Embedded



## Prerequisites

In SAP HANA, add the Connect AI static IP addresses to your connection whitelist.

## Setup Guide

Follow these steps to connect SAP HANA to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP HANA* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select an **AuthScheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the SAP HANA username for authentication
        * **Password**—the user password
        * **Database**—the name of the SAP HANA database
        * **Port**—the port for connecting to the SAP HANA server
        * **Server**—the host name or IP address of the server running the SAP HANA database
        * **Schema**—(Optional) the SAP database schema
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the following information:

        * **User**—the SAP HANA username for authentication
        * **Password**—the user password
        * **SSO Properties**—format these properties like 'SSOProperty1=value1;SSOProperty2=value2;SSOProperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
        * **Database**—the name of the SAP HANA database
        * **Port**—the port for connecting to the SAP HANA server
        * **Server**—the host name or IP address of the server running the SAP HANA database
        * **Schema**—(Optional) the SAP database schema
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAP HANA, see [this information page](https://cdn.cdata.com/help/SNM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP HANA XSA
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPHanaXSA-Embedded



## Prerequisites

Complete these steps before configuring the connection (OAuth and OAuthPassword only):

<Steps>
  <Step>
    In your SAP HANA XSA environment, create an OAuth client through the XSUAA service.
  </Step>

  <Step>
    From the XSUAA service instance, retrieve the client ID, client secret, and XSUAA URL. You enter these values in the steps below.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SAP HANA XSA to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP HANA XSA* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of the OData service endpoint.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the following information:

        * **User**–the SAP HANA XSA username for authentication.
        * **Password**–the authenticating user's password.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**–the client ID from your XSUAA service instance.
        * **OAuth Client Secret**–the client secret from your XSUAA service instance.
        * **XSUAAURL**–(optional) the URL from which to retrieve the OAuth access token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the following information:

        * **User**–the SAP HANA XSA username for authentication.
        * **Password**–the authenticating user's password.
        * **OAuth Client Id**–the client ID from your XSUAA service instance.
        * **OAuth Client Secret**–the client secret from your XSUAA service instance.
        * **XSUAAURL**–(optional) the URL from which to retrieve the OAuth access token.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAP HANA XSA, see [this information page](https://cdn.cdata.com/help/HHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP Hybris Cloud for Customer
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPHybrisC4C-Embedded



## Setup Guide

Follow these steps to connect SAP Hybris Cloud for Customer to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP Hybris Cloud for Customer* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Choose an **Auth Scheme**.

    * If you choose **Basic**, enter the following information.
      * **User**—the SAP Hybris Cloud for Customer username for authentication.
      * **Password**—the user password.
      * **Tenant**—the tenant to which you want to connect.
    * If you choose **AzureAD**, enter the following information.
      * **SSO Properties**—Single Sign-On (SSO) properties formatted like `SSOProperty1=value1;SSOProperty2=value2;`.
      * **Tenant**—the tenant to which you want to connect.
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

## More Information

For more information about interactions between Connect AI and SAP Hybris Cloud for Customer, see [this information page](https://cdn.cdata.com/help/OHM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP SuccessFactors
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPSuccessFactors-Embedded



## Prerequisites

Before you create the connection, gather the following information from your SAP SuccessFactors instance:

### Server URL

The URL of the server where your SAP SuccessFactors instance is hosted depends on your environment (production or preview) and data center location.

<Steps>
  <Step>
    Sign in to your SAP SuccessFactors instance and note the subdomain in the browser address bar (for example, `salesdemo4` in `https://salesdemo4.successfactors.com`).
  </Step>

  <Step>
    Open the [List of SAP SuccessFactors API Servers](https://help.sap.com/docs/successfactors-platform/sap-successfactors-api-reference-guide-odata-v2/list-of-sap-successfactors-api-servers) and find the row that matches your subdomain.
  </Step>

  <Step>
    Copy the corresponding **API Server URL** (for example, `https://api4.successfactors.com`). This is the value you enter for **URL** when configuring the connection.
  </Step>
</Steps>

If you cannot determine the correct API server, contact your SAP administrator or SAP Support.

### Company Id

<Steps>
  <Step>
    Sign in to your SAP SuccessFactors instance.
  </Step>

  <Step>
    Click your profile image in the upper-right corner, then select **Show version information**.
  </Step>

  <Step>
    In the dialog that opens, copy the value next to **Company ID**. This is the value you enter for **Company Id** when configuring the connection.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SAP SuccessFactors to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP SuccessFactors* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of the server where the SAP SuccessFactors instance is hosted. You located this information in the prerequisites.
  </Step>

  <Step>
    Enter the SAP SuccessFactors username for authentication in the **User** field.
  </Step>

  <Step>
    Enter your unique **Company Id** that you located in the prerequisites.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the **Password** for the **User** entered above.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth Client">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your SAP SuccessFactors account for OAuth.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** for your SAP SuccessFactors account for OAuth.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthSAML2">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** assigned when you registered your SAP SuccessFactors account for OAuth.
      </Step>

      <Step>
        Enter the PEM **Private Key** certificate downloaded upon registering your OAuth Client Application.
      </Step>

      <Step>
        At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and SAP SuccessFactors, see [this information page](https://cdn.cdata.com/help/GBM/cloud/default.htm#default).

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAP SuccessFactors LMS
Source: https://docs.cloud.cdata.com/en/Data-Sources/SAPSuccessFactorsLMS-Embedded



## Prerequisites

Before you create the connection, gather the following information from your SAP SuccessFactors instance:

### Server URL

The URL of the server where your SAP SuccessFactors instance is hosted depends on your environment (production or preview) and data center location.

<Steps>
  <Step>
    Sign in to your SAP SuccessFactors instance and note the subdomain in the browser address bar (for example, `salesdemo4` in `https://salesdemo4.successfactors.com`).
  </Step>

  <Step>
    Open the [List of SAP SuccessFactors API Servers](https://help.sap.com/docs/successfactors-platform/sap-successfactors-api-reference-guide-odata-v2/list-of-sap-successfactors-api-servers) and find the row that matches your subdomain.
  </Step>

  <Step>
    Copy the corresponding **API Server URL** (for example, `https://api4.successfactors.com`). This is the value you enter for **URL** when configuring the connection.
  </Step>
</Steps>

If you cannot determine the correct API server, contact your SAP administrator or SAP Support.

### Company Id

<Steps>
  <Step>
    Sign in to your SAP SuccessFactors instance.
  </Step>

  <Step>
    Click your profile image in the upper-right corner, then select **Show version information**.
  </Step>

  <Step>
    In the dialog that opens, copy the value next to **Company ID**. This is the value you enter for **Company Id** when configuring the connection.
  </Step>
</Steps>

### OAuth Credentials

Next, obtain a set of credentials related to your account's OAuth application.

<Steps>
  <Step>
    Log in to SAP SuccessFactors. Open the page selection menu at the top of the page, to the left of the search bar. The menu label is **Home** when you log in to the homepage. Click **Learning**.
  </Step>

  <Step>
    On the **Learning** page, open the **Dashboards** menu and click **Learning Administration**.
  </Step>

  <Step>
    On the **Learning Administration** page, click **System Administration** > **Application Administration** > **OAuth Token Server**. Note the value of the **Company ID** and the **Client ID**.
  </Step>

  <Step>
    Click **Generate a new Client Secret**. Note the value in the **Newly Generated Client Secret** field. This value is only displayed once, immediately after a new client secret is generated.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect SAP SuccessFactors LMS to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAP SuccessFactors LMS* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URL** of the server where the SAP SuccessFactors instance is hosted (for example, *[https://api4.successfactors.com](https://api4.successfactors.com)*). You located this information in the prerequisites.
  </Step>

  <Step>
    Enter your unique **Company Id** that you located in the prerequisites.
  </Step>

  <Step>
    Enter the user Id for the authenticating user in the **User** field.
  </Step>

  <Step>
    Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application (obtained in the prerequisites).
  </Step>

  <Step>
    Enter the **OAuth Client Secret** assigned to your custom OAuth application (obtained in the prerequisites).
  </Step>

  <Step>
    From the **User Type** drop-down list, select the user type that uses the LMS microservices (**Admin** or **User**).
  </Step>

  <Step>
    At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

    * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
    * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
    * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
  </Step>
</Steps>

<Note>
  Ready to try this connector? [Create a free Connect AI account](https://cloud-login.cdata.com/u/signup) and set up your first connection in minutes.
</Note>


# SAS Data Sets
Source: https://docs.cloud.cdata.com/en/Data-Sources/SASDataSets-Embedded



## Setup Guide

Follow these steps to connect SAS Data Sets to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *SAS Data Sets* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Enter the **URI** for the SAS resource location.
  </Step>

  <Step>
    Select the **Connection Type**, which specifies the file storage service, server, or file access protocol through which your SAS Data Sets files are stored and retrieved.
  </Step>
</Steps>

## Connection Types

<Tabs>
  <Tab title="Amazon S3">
    <Steps>
      <Step>
        Select the **AWS Region** from the drop-down list. This is the hosting region for your Amazon Web Services.
      </Step>

      <Step>
        (Optional) Enter the **Storage Base URL**. This specifies the URL of a cloud storage service provider.
      </Step>

      <Step>
        Select the **Auth Scheme** to use when connecting to remote services. Then select the tab for your authentication scheme and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AwsRootKeys">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsEC2Roles">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsIAMRoles">
        <Steps>
          <Step>
            Enter the **AWS Access Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Role ARN**. This is the Amazon Resource Name of the role to use when authenticating.
          </Step>

          <Step>
            (Optional) Enter the **AWS External Id**. This is a unique identifier that might be required when you assume a role in another account.
          </Step>

          <Step>
            (Optional) Enter the **MFA Serial Number**. This is the serial number of the MFA device, if one is being used.
          </Step>

          <Step>
            (Optional) Enter the **MFA Token**. This is the temporary token available from your MFA device.
          </Step>

          <Step>
            (Optional) Enter the **Temporary Token Duration**. This is the amount of time in seconds the temporary token will last.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="ADFS">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Okta">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="PingFederate">
        <Steps>
          <Step>
            Enter the **User** that the provider uses to authenticate.
          </Step>

          <Step>
            Enter the **Password** used to authenticate the user.
          </Step>

          <Step>
            Enter the identity provider's **SSO Login URL**.
          </Step>

          <Step>
            Enter the **SSO Exchange URL**. This is the URL used for consuming the SAML response and exchanging it for service specific credentials.
          </Step>

          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **AWS Principal ARN**. This is the ARN of the SAML Identity provider in your AWS account. You must specify the Principal ARN to use during authentication in the event you have multiple Identity Providers in your AWS Account.
          </Step>

          <Step>
            (Optional) Enter the **SSO Properties**. These are additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsTempCredentials">
        <Steps>
          <Step>
            Enter the **Access Key** used to authenticate to AWS. This value is accessible from your security credentials page.
          </Step>

          <Step>
            Enter the **AWS Secret Key**. This value is accessible from the AWS security credentials page.
          </Step>

          <Step>
            Enter the **AWS Session Token**. See the [AWS Documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html) for more information about the session token.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AwsCredentialsFile">
        <Steps>
          <Step>No additional settings are required for this authentication method.</Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="Keycloak">
        <Steps>
          <Step>
            Enter the **Keycloak Realm URL**. This specifies the full URL to the Keycloak server, including the specific realm used for authentication and authorization.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Blob Storage">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureStorageSAS">
        <Steps>
          <Step>
            Enter the **Azure Shared Access Signature**, a shared access key signature that may be used for authentication.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Azure Data Lake Storage Gen2">
    <Steps>
      <Step>
        Enter the name of your **Azure Storage Account**.
      </Step>

      <Step>
        Select the **Auth Scheme**, then proceed to the relevant section and follow those instructions.
      </Step>
    </Steps>

    ### Authentication Methods

    <Tabs>
      <Tab title="AzureAD">
        <Steps>
          <Step>
            (Optional) Toggle on **Use Lake Formation**. When this property is set to true, AWSLakeFormation service is used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through Okta, ADFS, AzureAD, and PingFederate, while providing a SAML assertion.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipal">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Secret** assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server (custom OAuth applications only).
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AzureServicePrincipalCert">
        <Steps>
          <Step>
            Enter the **Azure Tenant**, which is the SAS Data Sets tenant being used to access data. This field accepts either the tenant's domain name (for example, contoso.onmicrosoft.com) or its directory (tenant) Id.
          </Step>

          <Step>
            Enter the **OAuth JWT Cert**, which is the name of the client certificate's JWT certificate store.
          </Step>

          <Step>
            Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT certificate.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
          </Step>

          <Step>
            (Optional) Enter the **Scope** of the authenticating user's access to the application. If a custom OAuth application is needed, this is usually specified at the time the application is created.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Authorization URL** for the OAuth service.
          </Step>

          <Step>
            (Optional) Enter the **OAuth Access Token URL** from which the OAuth access token is retrieved.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Password**. This is the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
          </Step>

          <Step>
            (Optional) Enter the **OAuth JWT Cert Subject** of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '\*' to select the first certificate.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
            * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
          </Step>
        </Steps>
      </Tab>

      <Tab title="AccessKey">
        <Steps>
          <Step>
            Enter the **Azure Access Key**, which is the storage key associated with your Azure account.
          </Step>

          <Step>
            At the top of the Connect AI **Add  Connection** page, click **Save & Test**.

            * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
            * If the connection test fails, ensure that you entered your login information cor