Connection Options
The connection properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection settings for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.Account Id | The account identifier, or MID, of the target business unit. |
API Integration Type | The grant type for the OAuth flow. Accepted entries are Server-to-Server and Web-App. |
Auth Scheme | The type of authentication to use when connecting to Salesforce Marketing Cloud. |
Auto Cache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
Cache Driver | The database driver to be used to cache data. |
Cache Location | Specifies the path to the cache when caching to a file. |
Cache Metadata | This property determines whether or not to cache the table metadata to a file store. |
Cache Tolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
Callback URL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
Firewall Password | A password used to authenticate to a proxy-based firewall. |
Firewall Port | The TCP port for a proxy-based firewall. |
Firewall Server | The name or IP address of a proxy-based firewall. |
Firewall Type | The protocol used by a proxy-based firewall. |
Firewall User | The user name to use to authenticate with a proxy-based firewall. |
Initiate OAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
Instance | The instance of the Salesforce Marketing Cloud API used. |
List Data Extensions | A boolean determining if data extensions should be listed as tables or not. |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Logfile | A filepath which designates the name and location of the log file. |
Log Modules | Core modules to be included in the log file. |
Max Log File Count | 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. |
Max Log File Size | 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. |
Max Rows | 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. |
OAuth Access Token | The access token for connecting using OAuth. |
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 Expires In | The lifetime in seconds of the OAuth AccessToken. |
OAuth Refresh Token | The OAuth refresh token for the corresponding OAuth access token. |
OAuth Settings Location | 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://. |
OAuth Token Timestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
OAuth Verifier | The verifier code returned from the OAuth authorization URL. |
Offline | Use offline mode to get the data from the cache instead of the live source. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Salesforce Marketing Cloud. |
Password | The password used to authenticate the user. |
Proxy Auth Scheme | The authentication type to use to authenticate to the ProxyServer proxy. |
Proxy Auto Detect | 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. |
Proxy Exceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Proxy Password | A password to be used to authenticate to the ProxyServer proxy. |
Proxy Port | The TCP port the ProxyServer proxy is running on. |
Proxy Server | The hostname or IP address of a proxy to route HTTP traffic through. |
Proxy SSL Type | The SSL type to use when connecting to the ProxyServer proxy. |
Proxy User | A user name to be used to authenticate to the ProxyServer proxy. |
Pseudo Columns | This property indicates whether or not to include pseudo columns as columns to the table. |
Query All Accounts | Queries all accounts, including parent and all children, regarding an event. |
Readonly | You can use this property to enforce read-only access to Salesforce Marketing Cloud from the provider. |
RTK | The runtime key used for licensing. |
Schema | Specify the Salesforce Marketing Cloud server version to connect with. |
SSL Server Cert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Subdomain | The instance of the Salesforce Marketing Cloud API used. |
Support Enhanced SQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
Time Zone | The server timezone. The format should use the UTC offset, for example: +00:00. |
Use Legacy Authentication | A boolean determining if the connection should be made to Salesforce Marketing Cloud REST API using the legacy authentication or not. |
User | The Salesforce Marketing Cloud user account used to authenticate. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |