CData
Ascend utilizes CData Connectors to enable users to connect to various data sources, such as databases, web services, and APIs, using a JDBC interface. These connectors provide a consistent, uniform way to access and manipulate data, regardless of its source or format. CData Connectors support a wide range of data sources and provide advanced features like data modeling, caching, and query optimization.
Connection Properties
The following table describes the fields available when creating a new CData Connection. Create a connection using the information below and these step-by-step instructions.
| Field | Required | Description |
|---|---|---|
| Access Type | Required | This connection type is Read-Only. |
| Connection Name | Required | Input your desired name. |
| JDBC Type | Required | Select the connection you want to create. |
| JDBC Properties | Required | One property key value pair per line, in the format <key>=<value>. |
| Requires Credentials | Optional | Select this option if the JDBC type requires credentials such as username or API key. While creating a new credential is optional, it is recommended as a best practice. |
Credential Properties
The following table describes the fields available when creating a new CData credential.
| Field | Required | Description |
|---|---|---|
| Credential Name | Required | The name to identify this credential with. This credential will be available as a selection for future use. |
| Credential Type | Required | This field will automatically populate with CData. |
| Secret JDBC Properties | Required | One property key value pair per line, in the format <key>=<value>. |
Read Connector Properties
The following table describes the fields available when creating a new CData Read Connector. Create a new Read Connector using the information below and these step-by-step instructions.
| Field | Required | Description |
|---|---|---|
| Name | Required | Provide a name for your connector. We recommend using lowercase with underscores in place of spaces. |
| Description | Optional | Describes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons. |
JDBC Types and Properties
When setting up your connection, please use the following JDBC Properties for each type of interface. You have the option to input all properties, including those for credentials, directly into the 'JDBC Properties'. This might be useful if you don't wish to establish a new credential.
If you need to create a new credential for use across multiple connections, follow the templates below. These will guide you in two areas:
- Setting up the 'JDBC Properties' for your connection.
- Configuring the 'Secret JDBC Properties' for your credentials.
Remember, these instructions apply to each type of interface.
Active Campaign
The ActiveCampaign interface requires an ActiveCampaign URL and an API key.
"BaseId":"appxxN2fe34r3rjdG7"
"TableNames":"TableA,TableB,TableC"
"ViewNames":"TableA.ViewA,TableA.ViewB,..,TableX.ViewY"
"APIKey":"yourapikey"
AirTable
The AirTable interface JDBC Properties field requires a Base ID, Table Name, and View Names that correlate to Table Names. These values can be found in the Base URL ID. For Secret JDBC Properties, include your API key.
"URL":"yourURL"
"APIKey":"yourapikey"
Google Analytics 4
The Google Analytics 4 interface JDBC Properties field requires a Profile. For Secret JDBC Properties, include an OAuth 2.0 API key for the Profile. Alternatively, you can use the native Google Analytics Connection.
"Profile":"myProfile"
"InitiateOAuth":"GETANDREFRESH"
"OAuthClientID":"APIClientID"
"OAuthClientSecret":"APIClientSecret"
HubSpot
The HubSpot interface JDBC Properties, include the OAuth access token for the account.
"InitiateOAuth":"GETANDREFRESH"
Jira
The Jira interface JDBC Properties field requires your site URL. For Secret JDBC Properties, include your username and API token.
"Url":"https://yoursitename.atlassian.net"
"User":"admin"
"APIToken":"myApiToken"
Marketo
The Marketo interface JDBC Properties field requires a schema and the REST endpoint. For Secret JDBC Properties, include the Client ID and Client Secret. See the Marketo API Authentication documentation for more information.
"Schema":"REST"
"RESTEndpoint":"https://MyMarketoUrl/rest"
"OAuthClientId":"MyOAuthClientId"
"OAuthClientSecret":"MyOAuthClientSecret"
Salesforce
The Salesforce interface JDBC Properties field include a username. For Secret JDBC Properties, include the password and security token.
"User":"myUser"
"Password":"myPassword"
"Security Token":"myToken"
ServiceNow
To connect with ServiceNow, you'll need to create an endpoint for Ascend to access the instance. The interface JDBC Properties field requires your Service Now instance URL. For Secret JDBC Properties, include Client ID, Client Secret, from the and username and password.
"Url":"https://MyInstance12345.service-now.com/"
"InitiateOAuth":"GETANDREFRESH"
"OAuthClientId":"MyClientId"
"OAuthClientSecret":"MyClientSecret"
"User":"MyUser"
"Password":"MyPassword"
Shopify
To connect with Shopify, you'll need to create a custom app. The interface JDBC Properties field requires a Shop URL . For Secret JDBC Properties, include the OAuth name, Client ID, and Client Secret. Alternatively, you can use thenative Shopify Connection.
"ShopUrl":"https://yourshopname.myshopify.com"
"InitiateOAuth":"GETANDREFRESH"
"OauthClientId":"APIkeyvalue"
"OAuthClientSecret":"APIsecretkeyvalue"
Zendesk
The Zendesk interface JDBC Properties field requires the Zendesk URL. For Secret JDBC Properties, include a user email and password.
"URL":"https://subdomain.zendesk.com"
"User":"[email protected]"
"Password":"test123"
Updated about 1 year ago