Sources

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:

On the Sources page, click Add Connection. This action displays the Add Connection dialog.

Select a data source from the list in the dialog, or search for a connection by name.

After you select a data source, the Add Connection page for your data source appears.

Configure the connection according to the instructions for the data source. The instructions for setting up the connection appear in the right pane of the configuration page, in the Documentation tab. They are also available in this documentation. Look for your data source in the Data Sources section, or use the documentation’s search bar to search for your data source.

Click Save and Test.

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, you will see the new connection 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, the user interface displays error messages 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, the user interface displays an error message under the Sign in button. In some situations, refreshing your metadata cache for a connection can help fix loading or performance issues with your Connect AI application. To refresh your metadata cache, click Refresh Metadata at the top of the Edit Connection page. A success banner is displayed to indicate that the metadata cache has been refreshed.

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.

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.

Query users need to contact an administrator of the account to have a draft connection authenticated.

Data Credentials

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 per-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 User Credentials, a Data Credentials section appears under the Authentication section of the connection settings. Select either Shared Credentials or User Credentials.

The following restrictions apply to this feature:

This feature is only available for the following data sources. If this feature is desired for a data source that is not listed, please contact our support team to request it.
- Paylocity
- RedShift
- Sage Intacct
- Salesforce
- SharePoint
- Snowflake
- Workday
Only administrator users can toggle a data source between Shared Credentials and User Credentials, but users of all roles can log in to a User Credentials connection with their own credentials.
User Credentials are not supported when using the OData API. To connect a data source to the OData API, you must use Shared Credentials.

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 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.

Regardless of the verbosity level, sensitive connection properties—including passwords—are always masked in connection strings and any requests/responses.

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.

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 double check mark at the top of a table column to toggle that permission for every user.
Click the double check mark at the right side of the table to toggle all permissions for a single user.
Click the double check mark that is labeled All in the top-right corner of the table to toggle all permissions for all users.

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:

To add a custom report, follow these steps:

Click Add above the report table. A dialog appears with a list of the custom reports available for your chosen data source.

Select the report you want to use and click Confirm. A list of required and optional fields appear for the custom report.

Enter the requested information, and then click Save to save the custom report to your account.

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.

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.

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:

SELECT * FROM [QuickBooksOnline1].[QuickBooksOnline].[Customer Accounts List]

Edit a Custom Report

To edit an existing custom report, follow these steps:

In the report table, find the report you want to edit.

Click the report name or type, or click the edit button.

In Edit Custom Report, add or change report parameters.

Click Save Changes.

Duplicate a Custom Report from an Existing Report

To duplicate an existing custom report, follow these steps:

In the report table, find the report you want to duplicate.

Click the duplicate button. Connect AI creates a duplicate custom report for the data source with a new name.

Edit the Report Name, if desired, and click Save.

Delete a Custom Report

To delete an existing custom report, follow these steps:

In the report table, find the report you want to delete.

Click the delete button to the right of the report. Alternatively, you can click Delete on the Edit Custom Report page.

Click Delete again in the dialog to confirm.

Getting Started

Data Sources

Explore and Model

Integrations

Governance

Virtual Databases

Operations

Add a Connection

Data Credentials