Connection String OptionsBack To Top

AuthScheme
APIIntegrationType
UseLegacyAuthentication
User
Password
Subdomain
InitiateOAuth
OAuthClientId
OAuthClientSecret
OAuthAccessToken
OAuthSettingsLocation
CallbackURL
Scope
OAuthGrantType
OAuthVerifier
OAuthRefreshToken
OAuthExpiresIn
OAuthTokenTimestamp
SSLServerCert
FirewallType
FirewallServer
FirewallPort
FirewallUser
FirewallPassword
ProxyAutoDetect
ProxyServer
ProxyPort
ProxyAuthScheme
ProxyUser
ProxyPassword
ProxySSLType
ProxyExceptions
Logfile
Verbosity
LogModules
MaxLogFileSize
MaxLogFileCount
Location
BrowsableSchemas
Tables
Views
Schema
AutoCache
CacheDriver
CacheConnection
CacheLocation
CacheTolerance
Offline
CacheMetadata
AccountId
BatchSize
ConnectionLifeTime
ConnectOnOpen
DisplayChildDataExtensions
Instance
ListDataExtensions
MaxRows
Other
Pagesize
PoolIdleTimeout
PoolMaxSize
PoolMinSize
PoolWaitTime
PseudoColumns
QueryAllAccounts
Readonly
RTK
SupportEnhancedSQL
Timeout
TimeZone
UseConnectionPooling

AuthScheme

Data Type

string

Default Value

"Auto"

Remarks

Auto: Lets the driver decide automatically based on the other connection properties you have set.
OAuth: Set to this to perform OAuth authentication.
Basic: Set this to use BASIC user / password authentication.

When an app is created on SF Marketing Cloud, you are given an option of Web-API and Server-to-Server. This acts to determine the grant type for the OAuth flow. Use the following options to select your authentication grant type:

Server-to-Server: This is used when applications request an access token to access their own resources, not on behalf of a user. This indicates OAuthGrantType = Client.
Web-App: This is used by confidential and public clients to exchange an authorization code for an access token. This indicates OAuthGrantType = Code.

Optionally set OAuthGrantType directly instead of setting this property. Using OAuthGrantType may be desireable in cases where multiple products are being used to keep everything consistent since APIIntegrationType is specific to Salesforce Marketing Cloud.

UseLegacyAuthentication

Data Type

bool

Default Value

false

Remarks

To connect to Salesforce Marketing Cloud where you have installed a package with legacy functionality you must set this property to TRUE.

User

Data Type

string

Default Value

Remarks

Together with Password, this field is used to authenticate against the Salesforce Marketing Cloud server.

Password

Data Type

string

Default Value

Remarks

The User and Password are together used to authenticate with the server.

Subdomain

Data Type

string

Default Value

Remarks

The subdomain can be obtained as follows:

Log in to Marketing Cloud.
Navigate to the Setup page, then select: Apps -> Installed Packages
Select the package with the API integration component you want to use.
Subdomain will be specified in the Authentication Base URI. Example: https://SUBDOMAIN.auth.marketingcloudapis.com/

Note: This property must be specified if UseLegacyAuthentication is set to FALSE or if Instance is greater than s10.

InitiateOAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

Data Type

string

Default Value

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

Data Type

string

Default Value

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

Data Type

string

Default Value

Remarks

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 user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\SFMarketingCloud Data Provider\\OAuthSettings.txt"

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.

Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

If left unspecified, the default location is "%APPDATA%\\CData\\SFMarketingCloud Data Provider\\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

CallbackURL

Data Type

string

Default Value

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

Scope

Data Type

string

Default Value

Remarks

Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages.

OAuthGrantType

Data Type

string

Default Value

Remarks

When an app on is created on Salesforce Marketing Cloud, you are given an option of Web-API or Server-to-Server. Use the following options to select your authentication grant type:

Server-to-Server: This is used when applications request an access token to access their own resources, not on behalf of a user. This indicates OAuthGrantType = Client.
Web-App: This is used by confidential and public clients to exchange an authorization code for an access token. This indicates OAuthGrantType = Code.

APIIntegrationType may alternatively be specified to indicate the GrantType.

OAuthVerifier

Data Type

string

Default Value

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See Establishing a Connection to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

Data Type

string

Default Value

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

Data Type

string

Default Value

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

Data Type

string

Default Value

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSLServerCert

Data Type

string

Default Value

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

FirewallType

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.


Type	Default Port	Description
TUNNEL	80	When this is set, the driver opens a connection to Salesforce Marketing Cloud and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Data Type

string

Default Value

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

Data Type

int

Default Value

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

Data Type

string

Default Value

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

Data Type

string

Default Value

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

ProxyAutoDetect

Data Type

bool

Default Value

false

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

NOTE: When this property is set to True, the proxy used is determined as follows:

A search from the JVM properties (http.proxy, https.proxy, socksProxy, etc.) is performed.
In the case that the JVM properties don't exist, a search from java.home/lib/net.properties is performed.
In the case that java.net.useSystemProxies is set to True, a search from the SystemProxy is performed.
In Windows only, an attempt is made to retrieve these properties from the Internet Options in the registry.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

Data Type

string

Default Value

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

Data Type

int

Default Value

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

Data Type

string

Default Value

"BASIC"

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The driver performs HTTP BASIC authentication.
DIGEST: The driver performs HTTP DIGEST authentication.
NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

Data Type

string

Default Value

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain

domain\user

ProxyPassword

Data Type

string

Default Value

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


AUTO	Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

Data Type

string

Default Value

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logfile

Data Type

string

Default Value

Remarks

Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.

Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.

If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.

For more control over what is written to the log file, you can adjust the Verbosity property.

Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.

To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.

If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.

Java Logging

Java logging is also supported. To enable Java logging, set Logfile to:

Logfile=JAVALOG://myloggername

As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.

The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.

When Java logging is enabled, the Verbosity will now correspond to specific logging levels.

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

LogModules

Data Type

string

Default Value

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

MaxLogFileSize

Data Type

string

Default Value

"100MB"

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.

Adjust the maximum number of logfiles generated with MaxLogFileCount.

MaxLogFileCount

Data Type

int

Default Value

-1

Remarks

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.

The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Adjust the maximum size of the logfiles generated with MaxLogFileSize.

Location

Data Type

string

Default Value

"%APPDATA%\\CData\\SFMarketingCloud Data Provider\\Schema"

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

Note: Given that this driver supports multiple schemas, the structure for Salesforce Marketing Cloud custom schema files is as follows:

Each schema is given a folder corresponding to that schema name.
These schema folders are contained in a parent folder.
The parent folder should be set as the Location, not an individual schema's folder.

If left unspecified, the default location is "%APPDATA%\\CData\\SFMarketingCloud Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

BrowsableSchemas

Data Type

string

Default Value

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

Data Type

string

Default Value

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Data Type

string

Default Value

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Schema

Data Type

string

Default Value

"SOAP"

Remarks

Set this property to REST to use the Salesforce Marketing Cloud 1.x REST API or SOAP to use the Salesforce Marketing Cloud SOAP API.

AutoCache

Data Type

bool

Default Value

false

Remarks

When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice. By default, the driver incrementally updates the cache, retrieving only changes since the last SELECT query was run if the length of time since the last run has exceeded the CacheTolerance. After the cache is updated, the query is executed against the cached data.

Setting the Caching Database

When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

CacheLocation: Specifies the path to the file store.
CacheDriver and CacheConnection: Specifies a driver to a database and the connection string.

CacheDriver

Data Type

string

Default Value

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.

Note that you must also add the CacheDriver JAR file to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:

jdbc:sfmarketingcloud:CacheLocation='c:/Temp/cachedir';User=myUser;Password=myPassword;

To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:

jdbc:sfmarketingcloud:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';User=myUser;Password=myPassword;

SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:sfmarketingcloud:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';User=myUser;Password=myPassword;

MySQL

The following is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:sfmarketingcloud:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';User=myUser;Password=myPassword;

SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:sfmarketingcloud:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';User=myUser;Password=myPassword;

Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:sfmarketingcloud:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';User=myUser;Password=myPassword;

NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .

PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:sfmarketingcloud:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';User=myUser;Password=myPassword;

CacheConnection

Data Type

string

Default Value

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

Derby and Java DB

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]

For example, to cache to an in-memory database, use the following:

jdbc:derby:memory

SQLite

To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:

jdbc:sqlite:dataSource

Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

MySQL

The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache

The following are typical connection properties:

Server: The IP address or domain name of the server you want to connect to.
Port: The port that the server is running on.
User: The user name provided for authentication to the database.
Password: The password provided for authentication to the database.
Database: The name of the database.

SQL Server

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]

For example:

jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true

The following are typical SQL Server connection properties:

Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
Port: The port SQL Server is running on.
Database: The name of the SQL Server database.
Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.
To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.
User Id: The user name provided for authentication with SQL Server. This property is only needed if you are not using integrated security.
Password: The password provided for authentication with SQL Server. This property is only needed if you are not using integrated security.

Oracle

The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]

For example:

jdbc:oracle:thin:scott/tiger@myhost:1521:orcl

The following are typical connection properties:

Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
Password: The password provided for authentication with the Oracle database.
User Id: The user Id provided for authentication with the Oracle database.

PostgreSQL

The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]

For example, the following connection string connects to a database on the default host (localhost) and port (5432):

jdbc:postgresql:postgres

The following are typical connection properties:

Host: The address of the server hosting the PostgreSQL database.
Port: The port used to connect to the server hosting the PostgreSQL database.
Database: The name of the database.
User name: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
Password: The password provided for authentication with the PostgreSQL database.

CacheLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\SFMarketingCloud Data Provider"

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

If left unspecified, the default location is "%APPDATA%\\CData\\SFMarketingCloud Data Provider" with %APPDATA% being set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Mac	~/Library/Application Support
Linux	~/.config

CacheTolerance

Data Type

int

Default Value

600

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.

Offline

Data Type

bool

Default Value

false

Remarks

When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

CacheMetadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the Salesforce Marketing Cloud catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata

When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metadata changes often.
When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use REPLICATE Statements or CACHE Statements to cache explicitly.

AccountId

Data Type

string

Default Value

Remarks

Use this property to switch between business units. If you don't specify account_id, the returned access token is in the context of the business unit that created the integration. The specified AccountId will be used only during the OAuth flow. It is not supported for legacy packages.

BatchSize

Data Type

int

Default Value

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.

ConnectionLifeTime

Data Type

int

Default Value

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.

ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

When set to true, a connection will be made to Salesforce Marketing Cloud when the connection is opened. This property enables the Test Connection feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to Salesforce Marketing Cloud and nothing from this initial connection is maintained.

Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).

DisplayChildDataExtensions

Data Type

bool

Default Value

false

Remarks

Use this property to list child accounts data extension objects. By default, only parent and shared data extensions are displayed.

Instance

Data Type

string

Default Value

"s7"

Remarks

The Salesforce Marketing Cloud instance used by default is s7. To determine your instance, follow the steps below:

Log in to Marketing Cloud.
Click the name of your account.
Copy the MID value for your account.
In a separate browser tab or window, navigate to https://trust.marketingcloud.com.
Enter the copied MID value in the text field and click Go.

Note: If the instance is greater than s10, then Subdomain must be specified.

ListDataExtensions

Data Type

bool

Default Value

true

Remarks

A boolean determining if data extensions should be listed as tables or not.

MaxRows

Data Type

int

Default Value

-1

Remarks

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

Data Type

string

Default Value

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Caching Configuration


CachePartial=True	Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True	Passes the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Pagesize

Data Type

int

Default Value

500

Remarks

The Pagesize property affects the maximum number of results to return per page from Salesforce Marketing Cloud. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PoolIdleTimeout

Data Type

int

Default Value

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.

PoolMaxSize

Data Type

int

Default Value

100

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.

PoolMinSize

Data Type

int

Default Value

Remarks

The minimum number of connections in the pool. The default is 1.

PoolWaitTime

Data Type

int

Default Value

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.

PseudoColumns

Data Type

string

Default Value

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

QueryAllAccounts

Data Type

bool

Default Value

false

Remarks

Use this property to query all accounts, including parent and all children, regarding an event. Available only for SOAP schema.

Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

RTK

Data Type

string

Default Value

Remarks

The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

SupportEnhancedSQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL = true, the driver offloads as much of the SELECT statement processing as possible to Salesforce Marketing Cloud and then processes the rest of the query in memory. In this way, the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL = false, the driver limits SQL execution to what is supported by the Salesforce Marketing Cloud API.

Execution of Predicates

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

The driver retrieves all rows necessary to process the aggregation in memory.

Timeout

Data Type

int

Default Value

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the driver throws an exception.

TimeZone

Data Type

string

Default Value

"-06:00"

Remarks

If you have contacted your Marketing Cloud representative to disable the "Incoming Date Normalization" feature, you must specify the Account timezone instead of server timezone.

UseConnectionPooling

Data Type

bool

Default Value

false

Remarks

This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

Assets

Create, update, delete and query assets from your SalesForce Marketing Cloud account.

Table Specific Information

Select

Select all assets:

SELECT * FROM ASSETS

Retrieve a specific asset:

SELECT * FROM ASSETS WHERE ID=20088

Advanced server side filtering using 'AND' and 'OR' logical operators are supported for this table. You can check in the table info if the column has supported filters. All the columns which have supported filters, also can be sorted server side.

SELECT * FROM ASSETS WHERE (Id=5895 OR Id=19442) AND EnterpriseId=7307527 ORDER BY Name ASC, Id DESC

Columns


Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	Integer	True		=,!=,<,<=,>,>=	The Id of the Asset.
CustomerKey	String	False		=,!=	Reference to customer's private ID/name for the asset.
ObjectId	String	True			System-controlled, read-only text string identifier for object.
Name	String	False		=,!=	Name of the asset, set by the client.
Description	String	False		=,!=	Description of the asset, set by the client.
OwnerId	Integer	True		=,!=,<,<=,>,>=	The Id of the asset owner.
OwnerName	String	True		=,!=	The name of the asset owner.
OwnerEmail	String	True		=,!=	The email of the asset owner.
OwnerUserId	Integer	True			The user Id of the asset owner.
CreatedDate	Datetime	True		=,!=,<,<=,>,>=	The datetime when the asset was created.
CreatorId	Integer	True		=,!=,<,<=,>,>=	The Id of the asset creator.
CreatorName	String	True			The name of the asset creator.
CreatorEmail	String	True			The email of the asset creator.
CreatorUserId	Integer	True			The user Id of the asset creator.
ModifiedDate	Datetime	True		=,!=,<,<=,>,>=	The last datetime when the asset was modified.
ModifierId	Integer	True		=,!=,<,<=,>,>=	The Id of the asset modifier.
ModifierName	String	True			The name of the asset modifier.
ModifierEmail	String	True			The email of the asset modifier.
ModifierUserId	Integer	True			The user Id of the asset modifier.
EnterpriseId	Integer	True		=,!=,<,<=,>,>=	A short description of the ...
MemberId	Integer	True		=,!=,<,<=,>,>=	Marketing Cloud MID (member ID) for your account.
ActiveDate	Datetime	False		=,!=,<,<=,>,>=	A short description of the ...
ExpirationDate	Datetime	False		=,!=,<,<=,>,>=	A short description of the ...
ContentType	String	False		=,!=	The type that the content attribute will be in.
TypeId	Integer	False		=,!=,<,<=,>,>=	The Id of the asset type.
TypeName	String	False			The name of the asset type.
TypeDisplayName	String	False			The display name of the asset type.
CategoryId	Integer	False		=,!=,<,<=,>,>=	The Id of the category where the asset is located.
CategoryName	String	False			The name of the category where the asset is located.
CategoryParentId	Integer	False			The Parent Id of the category where the asset is located.
Content	String	False		=,!=	The actual content of the asset.
Design	String	False		=,!=	Fallback for display when neither content nor supercontent are provided.
SuperContent	String	False		=,!=	Content that supersedes content in terms of display.
File	String	False			Base64-encoded string of a file associated with an asset.
FileProperties	String	False			Stores the different properties that this asset refers to if it is a file type.
ForwardHtml	String	False			Field inside the views object.
ForwardText	String	False			Field inside the views object.
HtmlContent	String	False			Field inside the views object.
HtmlSlots	String	False			Field inside the views object.
HtmlTemplate	String	False			Field inside the views object.
Preheader	String	False			Field inside the views object.
SubjectLine	String	False			Field inside the views object.
SubscriptionCenter	String	False			Field inside the views object.
Text	String	False			Field inside the views object.
ViewAsAWebPage	String	False			Field inside the views object.
GenerateFrom	String	False			Tells the sending compiler what view to use for generating this view's content.
Slots	String	False			Slots within the asset.
Blocks	String	False			Blocks within the asset.
MinBlocks	Integer	False			Minimum number of blocks within an asset.
MaxBlocks	Integer	False			Maximum number of blocks within an asset.
AllowedBlocks	String	False			List of blocks that are allowed in the asset.
Template	String	False			Template the asset follows.
CustomFields	String	False			Custom fields within an asset.
Data	String	False			Property bag containing the asset data.
Channels	String	False			List of channels that are allowed to use this asset.
Version	Integer	True			The version of the asset.
Locked	Boolean	False			Specifies if the asset can be modified or not.
Status	String	False			The asset's status.
Tags	String	False			List of tags associated with the asset.
BusinessUnitAvailability	String	False			A dictionary of member IDs that have been granted access to the asset.
SharingProperties	String	False			Allows you to share content with one or more business units that have Content Builder Sharing enabled.

Callbacks

Create, update, delete and query event notification callbacks

Table Specific Information

Select

Select all callbacks:

SELECT * FROM Callbacks

Retrieve a specific callback:

SELECT * FROM Callbacks WHERE CallbackId=94766

Columns


Name	Type	ReadOnly	References	Filters	Description
CallbackId [KEY]	String	False		=	The Id of the event notification callback.
CallbackName	String	False			The name of the event notification callback.
Url	String	False			The url of the event notification callback.
MaxBatchSize	Integer	False			Maximum batch size of the event notification callback.
Status	String	False			The status of the event notification callback.
StatusReason	String	False			The status reason of the event notification callback.

Campaigns

Create, update, delete and query Campaigns.

Table Specific Information

Select

Select all campaigns:

SELECT * FROM Campaigns

Retrieve a specific Campaign:

SELECT * FROM Campaigns WHERE Id = '3130'

Columns


Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	Integer	True		=	The Id of the Campaign.
Name	String	False			Name of the Campaign.
CampaignCode	String	False			The Campaign code.
Color	String	False			The Campaign color.
Favorite	Boolean	False			True if marked as favorite Campaign.
CreatedDate	Datetime	False			The exact time when the Campaign was created.
ModifiedDate	Datetime	False			Last time the Campaign was updated.
Description	String	False			Description of the Campaign.

EventDefinitions

Create, delete and query event definitions.

Table Specific Information

Select

Retrieve all event definitions:

SELECT * FROM EventDefinitions

Retrieve a specific event definition:

SELECT * FROM EventDefinitions WHERE Id='9955614b-02e7-4147-91a2-3f5f5fe9d679'

Retrieve all event definitions which are running in a specific mode:

SELECT * FROM EventDefinitions WHERE Mode='Test'

Retrieve all event definitions which contain the specified quoted phrase in their names:

SELECT * FROM EventDefinitions WHERE Contains(Name,'Welcome Journey')

Columns


Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	String	True		=	The Id of the event definition.
Type	String	False			The type of the event definition. The allowed values are Event, ContactEvent, DateEvent, RestEvent.
Name	String	False		Contains	A name for your Event Definition that identifies the event in Marketing Cloud.
CreatedDate	Datetime	True			The datetime when the event definition was created.
CreatedBy	Integer	True			The Id of the event definition creator.
ModifiedDate	Datetime	True			The datetime when the event definition was updated.
ModifiedBy	Integer	True			The Id of the event definition modifier.
Mode	String	False		=	The mode in which the event definitions can run. The allowed values are Production, Test. The default value is Production.
EventDefinitionKey	String	False			Unique Id for an Event Definition in Marketing Cloud. Don't include special characters.
DataExtensionId	String	False			The ID for the data extension associated with the event. Events fired from the API write to this data extension. Required only when not providing a schema.
DataExtensionName	String	False			The read-only name of the data extension associated with the event.
Description	String	False			The description of Event Definition.
Schema	String	False			Schema information for an event. The call uses this information to create a data extension associated with the Event Definition. Only required when not providing a dataExtensionId value.
SendableCustomObjectField	String	False			Defines the subscriber key or email address within a data extension. Required when defining a schema.
SendableSubscriberField	String	False			Indicates type of sendable subscriber field. The default value is SubscriberKey. Required when defining a schema.
Schedule	String	False			Creates an automation run daily according to the defined schedule. The call automatically adds a Fire Event activity to the automation. This automation fires events from the data extension defined as part of the Event Definition.
FilterDefinitionId	String	False			The Id of the filter definition.
FilterDefinitionTemplate	String	False			The template of the filter definition.
IconUrl	String	False			URL to an icon displayed in Event Administration and the Journey Builder Canvas that identifies an Event Definition.
Arguments	String	False			Contains filter criteria for the Event Definition. Only required for types other than event.
Configuration	String	False			Optional configuration data for the event. Only required for types other than event.
ConfigurationArguments	String	False			The configuration arguments of Event Definition.
Metadata	String	False			Optional data describing the event and its configuration. Only required for types other than event.
InteractionCount	Integer	False			The interaction counter.
IsVisibleInPicker	Boolean	False			Indicates whether the Event Picker shows the Event Definition to users when configuring a journey. The default value is true.
Category	String	False			Broad category of the event type. The default value is event.
PublishedInteractionCount	Integer	False			The published interaction counter.
AutomationId	String	False			The Id of the Automation.

FacebookMessengerProperties

Query and create Facebook messenger properties.

Table Specific Information

Select

Retrieve all registred facebook messenger properties:

SELECT * FROM FacebookMessengerProperties

Retrieve a specific registred facebook messenger property:

SELECT * FROM FacebookMessengerProperties WHERE PageId='1732555047025799'

Columns


Name	Type	ReadOnly	References	Filters	Description
PageId [KEY]	String	False		=	The PageId of the Facebook Messenger property.
ApplicationId	String	False			Facebook Application Id.
ApplicationSecret	String	False			Facebook Application Secret.
PageName	String	False			Facebook Page Name.
PageAccessToken	String	False			Access Token required to authenticate send messages requests to Facebook networks.
CallbackVerifyToken	String	False			Facebook Verify Token need to verify callback events.
EndpointUrl	String	False			Send API url of the Facebook network.
IsActive	Boolean	False			Indicate if the Facebook Messenger resource is active.
ApiVersion	String	False			The API version of the OTT property.

JourneyActivities

Create, update and query journey activities.

Table Specific Information

Select

Retrieve journey activities for the latest version of the specified journey:

SELECT * FROM JourneyActivities WHERE JourneyId='1cb643b5-3144-4d17-80fa-a1f0035e78e2'

Retrieve journey activities for a specific journey version:

SELECT * FROM JourneyActivities WHERE JourneyId='1cb643b5-3144-4d17-80fa-a1f0035e78e2' AND JourneyVersion=1

Retrieve journey activities from all journeys with a specific version:

SELECT * FROM JourneyActivities WHERE JourneyVersion=1

Columns


Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	String	True			This is the Marketing Cloud-provided unique ID for this particular activity.
JourneyId [KEY]	String	True	Journeys.Id	=	A unique identifier for this journey that is generated and assigned by the journey API during creation.
JourneyVersion [KEY]	Integer	True	Journeys.Version	=	This number denotes the iteration of this particular journey.
Key	String	False			This is the customer key (journey-unique) for this particular activity.
Name	String	False			This is the display name for this activity, it will be shown in the Journey Builder UI.
Description	String	False			This is the description for this activity.
Type	String	False			This property defines what type of activity this is. The expected input for each activity must be passed as an argument to operate correctly.
Outcomes	String	False			This is a json array of 'outcome' objects.
Arguments	String	False			This is an object which represents the arguments this particular activity expects to be passed for use at runtime. Each activity type has its own unique argument parameters which are expected.
ConfigurationArguments	String	False			This is an object which represents the arguments this particular activity expects to be passed for use both at publish and runtime. Each activity type has its own unique argument parameters which are expected.

Journeys

Create, update, delete and query journeys.

Table Specific Information

Select

Retrieve journeys with the most recent version:

SELECT * FROM Journeys

Retrieve a journey version:

SELECT * FROM Journeys WHERE ID='1cb643b5-3144-4d17-80fa-a1f0035e78e2' AND Version=1

Retrieve all journey versions:

SELECT * FROM Journeys WHERE MostRecentVersionOnly=false

Retrieve journeys with a specific tag:

SELECT * FROM Journeys WHERE Tag='First_Tag'

Retrieve journeys which have the specified search string inside the name or description:

SELECT * FROM Journeys WHERE NameOrDescription='Journey'

Retrieve journeys with specific work flow API version:

SELECT * FROM Journeys WHERE workFlowApiVersion=1

Retrieve journeys with specific version:

SELECT * FROM Journeys WHERE Version=1

Retrieve journeys with specific status:

SELECT * FROM Journeys WHERE Status='Draft'

Sort Journeys according to modifiedDate or name column:

SELECT * FROM Journeys Order BY ModifiedDate DESC

SELECT * FROM Journeys Order BY Name DESC

Columns


Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	String	True		=	A unique identifier for this journey that is generated and assigned by the journey API during creation.
Version	Integer	True		=	This number denotes the iteration of this particular journey.
Key	String	False			The customer key (also a unique identifier within the MID) for this journey.
Name	String	False			The display name used in the Journey Builder UI for this journey, this will be visible to everyone who logs into your Marketing Cloud account.
Status	String	False		=	A status description upon which to filter journeys. The allowed values are Draft, Published, ScheduledToPublish, Stopped, Unpublished, Deleted.
CreatedDate	Datetime	True			The datetime when the journey was created.
ModifiedDate	Datetime	True			The datetime when the journey was updated.
LastPublishedDate	Datetime	True			The datetime when the journey was last published.
Description	String	False			The human readable description of this journey that informs others of purpose.
WorkFlowApiVersion	Integer	False		=	The version of work flow API. The default value is 1.
Tags	String	False			Assigned tags to the journey.
Goals	String	False			This is an array of goals containing a single object.
Triggers	String	False			This is an array of triggers containing a single object.
Defaults	String	False			This object contains an ordered list of email expressions used to determine which email address to use as the default, starting with the first expression.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
MostRecentVersionOnly	Boolean	A flag to indicate whether to fetch only the most recent version of matching journeys. The default value is true.
Tag	String	Specify a single tag to filter results to only include journeys associated with that tag.
NameOrDescription	String	A search string inside the journey's name or description properties upon which to match for filtering.

LineMessengerProperties

Query and create Line messenger properties.

Table Specific Information

Select

Retrieve all registred line messenger properties:

SELECT * FROM LineMessengerProperties

Retrieve a specific registred line messenger property:

SELECT * FROM LineMessengerProperties WHERE ID='23493453984234345'

Columns


Name	Type	ReadOnly	References	Filters	Description
ChannelId [KEY]	String	False		=	The Id of the LINE Messenger property.
ChannelName	String	False			LINE channel name.
ChannelSecret	String	False			LINE channel secret.
CustomerConnectSecret	String	False			LINE Customer Connect Secret needed for validating LINE inbound events when using Switcher API.
IsTransactional	Boolean	False			Indicate if LINE channel is Transactional or Reseller.
IsTestChannel	Boolean	False			Indicate if LINE channel is a Test channel.
EndpointUrl	String	False			Send API url of the LINE network.
IsActive	Boolean	False			Indicate if the LINE Messenger resource is active.
ApiVersion	String	False			The API version of the OTT property.

Subscriptions

Create, update, delete and query event notification subscriptions.

Table Specific Information

Select

Select all subscriptions:

SELECT * FROM Subscriptions

Retrieve a specific subscription:

SELECT * FROM Subscriptions WHERE SubscriptionId=94766

Columns


Name	Type	ReadOnly	References	Filters	Description
SubscriptionId [KEY]	String	False		=	The Id of the event notification subscription.
SubscriptionName	String	False			The name of the event notification subscription.
CallbackId	String	False	Callbacks.CallbackId	=	The Id of the event notification callback.
CallbackName	String	False			The name of the event notification callback.
EventCategoryTypes	String	False			Event category types.
Filters	String	False			Filters.
Url	String	False			The url of the event notification callback.
MaxBatchSize	Integer	False			Maximum batch size of the event notification callback.
Status	String	False			The status of the event notification callback.
StatusReason	String	False			The status reason of the event notification callback.

ViewsBack To Top

AssetTypes
CampaignAssets
Contact
Contacts
JourneyAuditLogs
SmsStatusCodes

AssetTypes

Get all available asset types in Salesforce Marketing Cloud.

Table Specific Information

Select

Retrieve all asset types:

SELECT * FROM AssetTypes

Columns


Name	Type	References	Description
Id [KEY]	Integer	Assets.TypeId	The Id of the asset type.
Name	String		The name of the asset type.
IsBaseAssetType	Boolean		Whether the asset type is a base asset type or not.
ParentId	Integer		The Id of the parent asset type.

CampaignAssets

Retrieve all campaign assets in Salesforce Marketing Cloud.

View Specific Information

Select

Select all campaign assets for a specific campaign:

SELECT * FROM CampaignAssets WHERE CampaignId = '3130'

Retrieve a specific Campaign:

SELECT * FROM CampaignAssets WHERE CampaignId = '3130' AND Id = '3325'

Columns


Name	Type	References	Description
Id [KEY]	Integer		The Id of the campaign asset.
CampaignId	Integer	Campaigns.Id	CampaignId assosiated with the asset.
Type	String		Type of the campaign asset.
ItemId	String		Internal object id.
CreatedDate	Datetime		The exact time when the asset was created.

Contact

Retrieve contacts in Salesforce Marketing Cloud.

Table Specific Information

Select

Retrieve all contacts:

SELECT * FROM Contact

Note: Most columns for this table are dynamic so they may not be the same as the columns specified below because you can have a different Contact schema in your Salesforce marketing cloud account.
Contacts that are in a deleted, deleting, or restricted state are not retrieved.

Columns


Name	Type	References	Description
ContactID [KEY]	Int		The system defined identifier of the contact.
ContactKey	String		The user defined identifier of the contact.

Contacts

Retrieve all contacts in Salesforce Marketing Cloud.

Table Specific Information

Select

Retrieve all contacts:

SELECT * FROM Contacts

Columns


Name	Type	References	Description
GroupConnect LINE Demographics.Address ID	String		This is an autogenerated description
GroupConnect LINE Demographics.Contact ID	Long		This is an autogenerated description
GroupConnect LINE Demographics.Contact Key	String		This is an autogenerated description
Contact.Contact ID [KEY]	Int		The system defined identifier of the contact.
Contact.Contact Key	String		The user defined identifier of the contact.
Email Demographics.Contacts ID	Long		This is an autogenerated description
Email Demographics.NewAttrTest	String		Test new attr
Email Demographics.NewAttrTest1	String		New Attr test
Email Demographics.NewAttrTest 2	String		NewAttrTest 2
Email Demographics.tet	String		test
Email Addresses.Email Address	String		This is an autogenerated description
Email Addresses.HTML Enabled	Bool		This is an autogenerated description
MobileConnect Demographics.Contact ID	Long		This is an autogenerated description
MobileConnect Demographics.Locale	String		This is an autogenerated description
MobileConnect Demographics.Mobile Number	String		This is an autogenerated description
MobilePush Demographics.Application	String		This is an autogenerated description
MobilePush Demographics.Contact ID	Long		This is an autogenerated description
MobilePush Demographics.Device ID	String		This is an autogenerated description
Contact.Business Unit ID	Int		This is an autogenerated description
Email Addresses.Member ID	Int		This is an autogenerated description
Email Addresses.List ID	Int		This is an autogenerated description

JourneyAuditLogs

Retrieves an audit log of a journey and its versions.

Columns


Name	Type	References	Description
JourneyId	String	Journeys.Id	A unique identifier for this journey that is generated and assigned by the journey API during creation.
JourneyVersion	Integer	Journeys.Version	This number denotes the iteration of this particular journey.
Key	String		The customer key (also a unique identifier within the MID) for this journey.
Action	String		The actions used to build your audit log. The allowed values are all, create, modify, publish, unpublish, delete. The default value is all.
Name	String		This is the display name for this activity, it will be shown in the Journey Builder UI.
Description	String		This is the description for the journey.
ActionDate	Datetime		The datetime of the action.
UserId	Integer		Id of user who performed the action.
UserName	String		Name of user who performed the action.
ExecutionMode	String		The execution mode in which the journey is running.
OriginalDefinitionId	String		The original definition Id of the journey.
PublishRequestId	String		The Id of the publish request.
PublishStatus	String		The status of the journey publication.
Errors	String		Errors occurred during the action.
ContactsEjected	String		Ejected Contacts when journey is stopped.

SmsStatusCodes

Query sms status codes.

Table Specific Information

Select

Retrieve all status codes for the following countries: U.S., Canada, Brazil, and India. Use these codes to evaluate and troubleshoot your SMS sends.

SELECT * FROM SmsStatusCodes

Columns


Name	Type	References	Description
Code [KEY]	Integer		The SMS code.
Status	String		The SMS status for the respective Code.
Definition	String		The definition for the SMS status Code.

Matillion Data Model for Salesforce Marketing Cloud Query RESTVersion - 21.0.8222.0

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Authentication on Headless Machines

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Matillion Data Model for Salesforce Marketing Cloud Query REST
Version - 21.0.8222.0