Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The following are the properties for connecting to MailChimp. The required properties are identified using the *** characters.
If a connection string property value has special characters such as semicolons, single quotes, spaces, etc., then you must quote the value using either single or double quotes.
Other properties (Proxy...) are detailed in section common properties
There are two authentication methods available for connecting to MailChimp. You can set the APIKey to the key you generate in your account settings. Instead of providing your APIKey, you can use the OAuth standard to authenticate the application.
API Key
The API key used for accessing your MailChimp account.
The API key used for accessing your MailChimp account. The API key can be found in MailChimp by going to Account -> Extras -> API Keys.
Initiate OAuth
This property sets whether the provider will initiate the process to obtain the OAuthAccessToken and OAuthServerUrl when it connects. If this property is set, the provider also automatically exchanges the refresh token for a new, valid OAuth access token. Default value is false.
OAuth Access Token
The OAuth access token secret of the authenticated account.
The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.
The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.
OAuth Client Id***
The client Id assigned when you register your application with an OAuth authorization server.
OAuth requires you to register your application. As part of the registration, you will receive a client Id, sometimes also called a consumer key, and a client secret. You must specify both the OAuthClientId andOAuthClientSecret to connect to an OAuth server.
OAuth requires you to register your application. As part of the registration, you will receive a client Id, sometimes also called a consumer key, and a client secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.
OAuth Client Secret***
The client secret assigned when you register your application with an OAuth authorization server.
OAuth requires you to register your application. As part of the registration you will receive a client Id and a client secret, sometimes also called a consumer secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.
OAuth requires you to register your application. As part of the registration you will receive a client Id and a client secret, sometimes also called a consumer secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.
OAuth Settings Location
The location of the settings file where OAuth values are saved when InitiateOAuth is set to true.
SSL Cert
The certificate to be accepted from the server when connecting using SSL.
If using an SSL connection, this property can be used to specify the SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected. This can take the form of a full PEM certificate, the path to a file containing the certificate, the public key, the MD5 thumbprint, or the SHA1 thumbprint. If not specified, any valid certificate will be accepted. Use '*' to signify to accept all certificates. Do not specify the SSLCert to only accept certificates that the machine already trusts.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation. Default value is 60.
If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition. If Timeout expires and the operation is not yet complete, the provider throws an exception.
The Salesforce Marketing Cloud REST API uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId and OAuthClientSecret connection properties.
You can follow the procedure below to register an app and obtain the OAuth client credentials, the Client Id and Client Secret:
Log in to your Salesforce Marketing Cloud Go to Marketing Cloud | Administration | Installed Packages.
Click New.
Give the package a name and description.
Save the package. Once the package is saved, you see important details about the package. See Installed Packages Definitions for more information about each field. You see the Package ID, JWT Signing Secret, and Source Account only for packages created in your account.
Under Components, click Add Component.
Select API Integration.
You must select Server-to-Server or Web App as integration type if the package supports enhanced functionality.
Assign the appropriate scope for your integration.
Perform server-to-server requests... is automatically selected for all API Integrations.
Select Perform requests on behalf of the user... if this package contains a Marketing Cloud app.
Select the Marketing Cloud scope for your API calls. Assign only the scope your package needs.
Save the component.
Under the component details, you can find the Client ID and Client Secret.
After setting the following connection properties, you are ready to connect:
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
OAuthClientId: Set this to the Client ID in your app settings.
OAuthClientSecret: Set this to the Client Secret in your app settings.
AccountId: Set this to the specific MID of the target business unit. This is not available for legacy packages.
CallbackURL: Set this to the URL in your app settings. Note: The default value is https://127.0.0.1:33333.
When you connect the provider completes the OAuth process.
Exchanges the OAuthClientId and OAuthClientSecret for the OAuthAccessToken.
Refreshes the access token when it expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
The Salesforce Marketing Cloud SOAP API can connect using either your login credentials, or Using OAuth Authentication.
To connect to data using basic (login credentials) authentication, set the following:
User: The Salesforce Marketing Cloud user account used to authenticate.
Password: The password used to authenticate the user.
to your login credentials, or to the credentials for a sandbox user if you are connecting to a sandbox account.
Once you have authenticated to either the SOAP or REST API, you are ready to connect to data.
You may optionally refine data access using the following properties:
UseSandbox: Set this to true to use a Salesforce Marketing Cloud sandbox account.
Instance: The instance of the Salesforce Marketing Cloud API used. The default Instance is s7 of the Web Services API; however, you can use this property to specify a different instance.
There are two authentication methods available for connecting to HubSpot data source: PrivateAppToken-based and OAuth Authentication.
Some tables in the HubspotV3 schema may not work with the OAuth mechanism. This API limitation restricts their usage only to the PrivateAppToken-based authentication. Specifically, each table in the data-model section will mention the supported authentication mechanism.
To connect using a Hubspot Private App Token, set the AuthScheme property to PrivateAppToken and OAuthAccessToken to the value of your application's access token, and you are ready to connect.
You can generate a HubSpot Private App Token by following the steps below:
In your HubSpot account, click the settings icon in the main navigation bar.
In the left sidebar menu, navigate to Integrations > Private Apps.
Click Create private app.
On the Basic Info tab, configure the details of your application (name, logo, and description).
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. Refer to the OAuthRequiredScopes and OAuthOptionalScopes properties for recommended scopes to select.
After you are done configuring your application, click create app in the top right.
Review the info about your application's access token, click Continue creating, and then Show token.
You can now set the retrieved token in the OAuthAccessToken property (OAuthAccessToken is used for Private App Access Tokens and OAuth Access Tokens).
You can set the AuthScheme to PrivateAppToken to enforce this Authentication scheme.
AuthScheme must be set to OAuth in all OAuth flows. The following OAuth flows assume you have done so.
Follow the steps below to register an application and obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret:
Log into your HubSpot developer account.
On the developer account home page, click Create an app or, if starting from the Apps dashboard, click Create app.
On the App info tab, enter and optionally modify values that are displayed to users when they connect. These values include the public application name, application logo, and a description of the application.
On the Auth tab, copy the client ID and client secret. You will use these later for the OAuthClientId and OAuthClientSecret properties.
Set CallbackURL to http://localhost:33333 or a trusted URL where users are redirected to after they authorize your application.
Under Scopes, select Standard > oauth, any additional scopes as needed for your application's functionality, and the data you want to retrieve (see the OAuthRequiredScopes and OAuthOptionalScopes properties for the default scopes requested by the driver).
Note that the requested scopes (OAuthRequiredScopes) must match the scopes specified in your application's settings.
After setting the following, you are ready to connect, Set the following connection properties to obtain the OAuthAccessToken:
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your application.
OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your application.
CallbackURL (custom application only): Set this to the redirect URI defined when you registered your application.
When you connect, the provider opens HubSpot's OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process:
The provider obtains an access token from HubSpot and uses it to request data.
Extracts the access token from the callback URL and authenticates requests.
Saves OAuth values in the location specified in OAuthSettingsLocation. These values persist across connections.
The provider refreshes the access token automatically when it expires.
To connect via Login, set AuthScheme to Basic. The standard method of authentication to Oracle Eloqua is via the login method. The Login method requires you to set Company and to set User, and Password to the credentials you use to log in. This method uses HTTP Basic authentication over SSL.
To connect via OAuth, set AuthScheme to OAuth.
You can follow the procedure below to obtain the client credentials, the client Id (app Id) and client secret:
Log in to Oracle Eloqua.
Click Settings -> AppCloud Developer (under Platform Extensions) -> Create New App.
Enter a name, icon, and description for the app to be displayed to users when they connect to Oracle Eloqua. The OAuthClientId and OAuthClientSecret will be displayed.
If you are creating a desktop application, set the CallbackURL to http://localhost:3000, or another port of your choice.
Eloqua requires that the Callback URL begins with https://. You must specify a port.
After setting the following, you are ready to connect:
OAuthClientId: Set this to the Client Id in your app settings.
OAuthClientSecret: Set this to the Client Secret in your app settings.
CallbackURL: Set this to the Redirect URL in your app settings.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
When you connect the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process:
Extracts the access token from the callback URL and authenticates requests.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
When setting the OAuthGrantType to password, an OAuth flow may be triggered that passes user credentials. In this case, there will be no browser window to authorize. Instead, the following connection properties will need to be set:
User - Set this to the user name.
User - Set this to the password.
Company - Set the company for the user.
OAuthClientId: Set this to the Client Id in your app settings.
OAuthClientSecret: Set this to the Client Secret in your app settings.
OAuthGrantType: Set this to password.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
The following are the connection properties for Oracle Eloqua. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.
You need to register a Bing Ads account, get a developer token, and authenticate using OAuth to connect to the Bing Ads APIs.
Complete the following steps to sign up for a Bing Ads account and obtain the CustomerId and (optional) AccountId:
Sign up for a Bing Ads account in the or at the for a sandbox account.
Select Settings > Accounts and Billing and select a single account. The AccountId and CustomerId (cid) are displayed on the account's page and in the page's URL.
To use the Bing Ads APIs, you must have a DeveloperToken in addition to the CustomerId. You must have the Super Admin role in Bing Ads to create a developer token, though you do not need special permissions to use the token.
Log in at the as a Microsoft Account user with the Bing Ads Super Admin role.
Click Request Token and take note of your developer token. You will set it in the DeveloperToken connection property.
The Bing Ads APIs use the OAuth 2 standard.
If you have not done so already, sign up for a Bing Ads account in the or at the for a sandbox account.
Go to the ( for sandbox accounts), and login with your Microsoft Account credentials when prompted.
Under Azure Active Directory --> App registrations, click New registration.
Provide the application name and select an appropriate Supported account type. Not selecting to allow personal Microsoft accounts will prevent users with personal accounts from authenticating.
Set the Redirect URI to the page in your Web application where you would like users to be redirected with the OAuthVerifier
Register your application and take note of your Application (client) Id. You will use it as the OAuthClientId value in the OAuth grant flow.
In the Certificates & secrets section, click New client secret to generate a client secret and take note of the resulting value. You will use it as the OAuthClientSecret value.
Property
Description
Authentication
Company
The company of the Eloqua account. This field is used to authenticate the user.
Password
The password of the Eloqua account used to authenticate.
User
The user of the Eloqua account. This field is used to authenticate the user.
Caching
AutoCache
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheConnection
The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocation
Specifies the path to the cache when caching to a file.
CacheMetadata
This property determines whether or not to cache the table metadata to a file store.
CacheProvider
The name of the provider to be used to cache data.
CacheTolerance
The tolerance for stale data in the cache specified in seconds when using AutoCache .
Offline
Use offline mode to get the data from the cache instead of the live source.
Firewall
FirewallPassword
A password used to authenticate to a proxy-based firewall.
FirewallPort
The TCP port for a proxy-based firewall.
FirewallServer
The name or IP address of a proxy-based firewall.
FirewallType
The protocol used by a proxy-based firewall.
FirewallUser
The user name to use to authenticate with a proxy-based firewall.
Logging
Logfile
A path to the log file.
MaxLogFileCount
A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Verbosity
The verbosity level that determines the amount of detail included in the log file.
Misc
BulkPollingInterval
The time interval between requests that check the availability of the bulk query response. The default value is 200 ms.
BulkQueryTimeout
The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes.
ConnectionLifeTime
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectionString
***
DataRetentionDuration
The length of time (in hours) that bulk data is stored on the server. Valid values are from 1 hour to 2 weeks. The default value is 24 hours.
DisplayColumnName
Specifies the dispaly name for columns. The possible settings are 'internal' and 'statement'.
MapDataCardsCaseSensitiveMatch
Whether or not to use case sensitive match in data card mapping.
MapDataCardsRelationship
Comma-separated list of the relationships between the Custom Object tables and the Entity tables.
MaxRows
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other
These hidden properties are used only in specific use cases.
Pagesize
The maximum number of results to return per page from Eloqua.
PoolIdleTimeout
The allowed idle time for a connection before it is closed.
PoolMaxSize
The maximum connections in the pool.
PoolMinSize
The minimum number of connections in the pool.
PoolWaitTime
The max seconds to wait for an available connection.
PseudoColumns
This property indicates whether or not to include pseudo columns as columns to the table.
Readonly
You can use this property to enforce read-only access to Oracle Eloqua from the provider.
RetryCount
The maximum number of times to retry a Bulk API request that fails due to an HTTP 500 status code (Internal Server Error).
RetryInterval
The time interval between attempts to retry a Bulk API request that failed with an HTTP 500 status code (Internal Server Error).
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
SupportEnhancedSQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
UseBulkAPI
Whether or not the bulk API is used for retrieving data.
UseConnectionPooling
This property enables connection pooling.
UseSimpleNames
Boolean determining if simple names should be used for tables and columns.
OAuth
CallbackURL
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
InitiateOAuth
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthAccessToken
The access token for connecting using OAuth.
OAuthClientId
The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret
The client secret assigned when you register your application with an OAuth authorization server.
OAuthRefreshToken
The OAuth refresh token for the corresponding OAuth access token.
OAuthSettingsLocation
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuthVerifier
The verifier code returned from the OAuth authorization URL.
State
An optional value that has meaning for your OAuth App.
Proxy
ProxyAuthScheme
The authentication type to use to authenticate to the ProxyServer proxy.
ProxyAutoDetect
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyExceptions
A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
ProxyPassword
A password to be used to authenticate to the ProxyServer proxy.
ProxyPort
The TCP port the ProxyServer proxy is running on.
ProxyServer
The hostname or IP address of a proxy to route HTTP traffic through.
ProxySSLType
The SSL type to use when connecting to the ProxyServer proxy.
ProxyUser
A user name to be used to authenticate to the ProxyServer proxy.
Schema
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Tables
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Both the REST and SOAP APIs are supported and can be chosen using the Schema property.
Before you can connect to the Marketo REST API, you will need to create a custom service.
To create a custom service, follow the procedure below:
Navigate to the admin area of your Marketo application.
Click Users & Roles in the Security section.
Select the Roles tab and click New Role to create a new Role.
Enter a Role Name and select the permissions for the Role. The Access API permissions are specific to the REST API.
Now that an API Role is created, select the Users tab and click Invite New User.
Enter the new user information and select the role that was just created with API access. The API Only option can be selected to denote the user as an API Only user.
Now that a new user has been created, a new service will need to be created. Click the LaunchPoint option (Admin -> Integration -> LaunchPoint).
Click New Service.
Select the Custom service type and enter a display name and description.
Select the user you created.
To obtain the OAuthClientId and OAuthClientSecret, navigate to the LaunchPoint option on the Admin area.
Click the View Details link for the desired service. A window containing the authentication credentials is displayed.
Once you have created a custom service and obtained your OAuth credentials, set the following to connect to data:
Schema: Set this to REST.
OAuthClientId: The OAuth Client ID associated with your custom service.
OAuthClientSecret: The OAuth Client Secret associated with your custom service.
RESTEndpoint: The URL of the REST Web service endpoint. This can be found on your Marketo Admin area on the Integration -> Web Services option in the REST API section.
The Identity Endpoint will not be needed.
To connect to the SOAP API, you will need to provide valid Marketo credentials. Specify the following to connect to data:
Schema: Set this to SOAP.
UserId: The client access ID is found within your Marketo admin SOAP API panel under Integration.
EncryptionKey: The Marketo SOAP API Encryption Key. This key is generated on the Admin page of the Marketo website.
SOAPEndpoint: The URL of the SOAP Web service endpoint, provided by Marketo on the Admin page of the Marketo website.
The following are the connection properties for Marketo. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.
Property
Description
Caching
AutoCache
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheConnection
The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocation
Specifies the path to the cache when caching to a file.
CacheMetadata
This property determines whether or not to cache the table metadata to a file store.
CacheProvider
The name of the provider to be used to cache data.
CacheTolerance
The tolerance for stale data in the cache specified in seconds when using AutoCache .
Offline
Use offline mode to get the data from the cache instead of the live source.
Firewall
FirewallPassword
A password used to authenticate to a proxy-based firewall.
FirewallPort
The TCP port for a proxy-based firewall.
FirewallServer
The name or IP address of a proxy-based firewall.
FirewallType
The protocol used by a proxy-based firewall.
FirewallUser
The user name to use to authenticate with a proxy-based firewall.
Logging
Logfile
A path to the log file.
MaxLogFileCount
A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Verbosity
The verbosity level that determines the amount of detail included in the log file.
Misc
ConnectionLifeTime
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectionString
***
JobPollingInterval
Specifies the polling interval (in seconds) when checking the status of a bulk API job.
MaxRows
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other
These hidden properties are used only in specific use cases.
PageSize
The number of results to return per page from Marketo.
PoolIdleTimeout
The allowed idle time for a connection before it is closed.
PoolMaxSize
The maximum connections in the pool.
PoolMinSize
The minimum number of connections in the pool.
PoolWaitTime
The max seconds to wait for an available connection.
PseudoColumns
This property indicates whether or not to include pseudo columns as columns to the table.
Readonly
You can use this property to enforce read-only access to Marketo from the provider.
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
SupportEnhancedSQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
UseBulkAPI
Specifies whether to use the Marketo Bulk API.
UseConnectionPooling
This property enables connection pooling.
OAuth
InitiateOAuth
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthAccessToken
The access token for connecting using OAuth.
OAuthClientId
The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret
The client secret assigned when you register your application with an OAuth authorization server.
OAuthSettingsLocation
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
Proxy
ProxyAuthScheme
The authentication type to use to authenticate to the ProxyServer proxy.
ProxyAutoDetect
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyExceptions
A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
ProxyPassword
A password to be used to authenticate to the ProxyServer proxy.
ProxyPort
The TCP port the ProxyServer proxy is running on.
ProxyServer
The hostname or IP address of a proxy to route HTTP traffic through.
ProxySSLType
The SSL type to use when connecting to the ProxyServer proxy.
ProxyUser
A user name to be used to authenticate to the ProxyServer proxy.
REST
RESTEndpoint
The Marketo REST API Endpoint.
Schema
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Schema
The type of schema to use.
Tables
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
SOAP
EncryptionKey
The Marketo SOAP API Encryption Key.
SOAPEndpoint
The Marketo SOAP API Endpoint.
UserId
The Marketo SOAP API User Id.