Skip to main content
Contact CData sales if you are interested in a Connect AI Embed account. Connect AI Embed consists of two levels of accounts:
  • Parent Account—CData sales creates the parent account. The parent account is responsible for managing the sub-accounts and can create, view, and edit sub-accounts through the Connect AI Embed API. The parent account can monitor and troubleshoot sub-accounts.
  • Sub-Account—In the sub-account, each end user will have his/her own account. The end users can create, edit, and delete data sources. They can connect to data sources and query data.
The Connect AI Embed Accounts page contains the sub-account names, external Id, and account Ids for reference.
Click the edit icon to change the account name or external Id. Click the delete icon to delete the sub-account.

​
Connect AI Embed Quickstart

The following is an overview of setting up Connect AI Embed. There are four main steps.

​
Step 1: Create a Parent Account

1
CData sets up a parent account for you and sends you the account information, including the account name and account Id.
2
The administrator of the Connect AI Embed parent account creates a JSON Web Token (JWT), 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.
3
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.
4
Once registered, the administrator of the parent account can sign in to the account. Please accept the terms of service.
5
The parent account’s administrator creates and manages the sub-accounts.

​
Step 2: Create a Sub-Account

Once you 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 in the Connect AI Embed API to create a sub-account. You must supply the JWT that you created in Create a Parent Account, as well as the External ID of the sub-account.

​
Step 3: Set Custom Overrides for Drivers (Optional)

Custom overrides allows the end users to log in with their own organization’s OAuth credentials, rather than CData credentials. To add connection overrides, follow these steps:
1
In the Sources tab of the Settings page, click +Add Override.
2
Search for the data source to override. Click Next.
3
Select the Setting to override.
4
Enter the Override Value.
5
Select whether the value should apply to new connections only or to all connections (new and existing).
6
Click Confirm.
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 Connnection, 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, he/she is then redirected back to your web page containing a list of connections. See Connection Flow for more details.

​
Step 5: Query the Data

Use one of the following Connect AI drivers to query the data: In addition, Connect AI Embed provides a full-featured REST API. You can query data directly with any REST-compatible application or integration tool capable of creating HTTP requests.

​
View Logs

Use the Logs page or the Log API to view and download a list of logs for a Connect AI Embed account.