Salesforce Marketing Cloud Connector for CData Sync

Build 24.0.9175
  • Salesforce Marketing Cloud
    • Establishing a Connection
      • Selecting From Data Extensions in SalesforceMarketingCloud
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • REST Data Model
        • Tables
          • Assets
          • Callbacks
          • Campaigns
          • Categories
          • EventDefinitions
          • FacebookMessengerProperties
          • JourneyActivities
          • Journeys
          • LineMessengerProperties
          • SendDefinitions
          • Subscriptions
        • Views
          • AssetTypes
          • CampaignAssets
          • Contact
          • Contacts
          • JourneyAuditLogs
          • JourneyHistory
          • SmsStatusCodes
          • TransactionalMessages
      • SOAP Data Model
        • Tables
          • Account
          • AccountUser
          • BusinessUnit
          • ContentArea
          • DataExtension
          • Email
          • EmailSendDefinition
          • FileTrigger
          • FilterDefinition
          • ImportDefinition
          • List
          • Portfolio
          • ProgramManifestTemplate
          • QueryDefinition
          • ReplyMailManagementConfiguration
          • Send
          • SendClassification
          • SenderProfile
          • SMSTriggeredSend
          • Subscriber
          • SuppressionListDefinition
          • TriggeredSendDefinition
        • Views
          • Automation
          • BounceEvent
          • ClickEvent
          • DataExtensionField
          • DataExtensionTemplate
          • DataFolder
          • DoubleOptInMOKeyword
          • FileTriggerTypeLastPull
          • ForwardedEmailEvent
          • ForwardedEmailOptInEvent
          • HelpMOKeyword
          • ImportResultsSummary
          • LinkSend
          • ListSend
          • ListSubscriber
          • MessagingVendorKind
          • NotSentEvent
          • OpenEvent
          • PrivateIP
          • Publication
          • PublicationSubscriber
          • PublicKeyManagement
          • ResultItem
          • ResultMessage
          • Role
          • SendEmailMOKeyword
          • SendSMSMOKeyword
          • SendSummary
          • SentEvent
          • SMSMTEvent
          • SMSSharedKeyword
          • SMSTriggeredSendDefinition
          • SubscriberList
          • SubscriberSendResult
          • SubscriberStatusEvent
          • SuppressionListContext
          • SurveyEvent
          • Template
          • TimeZone
          • TriggeredSendSummary
          • UnsubEvent
          • UnsubscribeFromSMSPublicationMOKeyword
    • Connection String Options
      • Authentication
        • AuthScheme
        • UseLegacyAuthentication
        • User
        • Password
        • Subdomain
        • UseAsyncBatch
        • WaitForBulkResults
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
        • Schema
      • Miscellaneous
        • AccountId
        • DisplayChildDataExtensions
        • Instance
        • ListDataExtensions
        • MaxRows
        • Other
        • Pagesize
        • PseudoColumns
        • QueryAllAccounts
        • Timeout
        • TimeZone
        • UserDefinedViews

Salesforce Marketing Cloud Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Salesforce Marketing Cloud data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Salesforce Marketing Cloud connector can be used from the CData Sync application to pull data from Salesforce Marketing Cloud and move it to any of the supported destinations.

Salesforce Marketing Cloud Version Support

The Sync App leverages the SOAP Web Service API and the REST API to enable bidirectional access to Salesforce Marketing Cloud.

Salesforce Marketing Cloud Connector for CData Sync

Establishing a Connection

Adding a Connection to Salesforce Marketing Cloud

To add a connection to Salesforce Marketing Cloud:

  1. In the application console, navigate to the Connections page.
  2. At the Add Connections panel, select the icon for the connection you want to add.
  3. If the Salesforce Marketing Cloud icon is not available, click the Add More icon to download and install the Salesforce Marketing Cloud connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Salesforce Marketing Cloud

For both REST and SOAP APIs, you have the option to refine data access using the following properties:

  • 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.
  • Subdomain: If the instance is greater than s10, you must also specify the subdomain.

REST API

To connect, set Schema to REST.

The Salesforce Marketing Cloud REST API uses the OAuth authentication standard. To authenticate using OAuth, you must create a custom OAuth application to obtain values for the OAuthClientId and OAuthClientSecret connection properties. See Creating a Custom OAuth App for more information.

SOAP API

To connect, set Schema to SOAP.

The Salesforce Marketing Cloud SOAP API can connect using OAuth, but also supports a legacy use of login credentials.

Note: Data extension objects in Salesforce Marketing Cloud are only accessible through the SOAP API.

Authenticating to Salesforce Marketing Cloud

User Accounts (OAuth)

Set the AuthScheme to OAUTH. Also, in all OAuth flows, set AccountId to the specific MID of the target business unit. NOTE: This is not available for legacy packages. The following OAuth sections assume that you have set both these connection properties.

Desktop Apps

Follow the steps below to authenticate with the credentials for a custom OAuth application. See Creating a Custom OAuth App for information about custom OAuth applications. Get an OAuth Access Token

After setting the following, you are ready to connect:

  • OAuthClientId: The Client Id in your application settings.
  • OAuthClientSecret: The Client Secret in your application settings.
  • CallbackURL: The Redirect URL in your application settings.
When you connect the Sync App opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

  1. Choose one of two options:
    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the Sync App on a machine with an Internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
  2. Then configure the Sync App to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an Internet browser and obtain the OAuthVerifier connection property.

  1. Choose one of these options:
    • If you are using the Embedded OAuth Application click Salesforce Marketing Cloud OAuth endpoint to open the endpoint in your browser.
    • If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
      • InitiateOAuth: Set to OFF.
      • OAuthClientId: Set to the client Id assigned when you registered your application.
      • OAuthClientSecret: Set to the client secret assigned when you registered your application.
      Then call the rpgrestsp-getoauthauthorizationurl stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
  2. Log in and grant permissions to the Sync App. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.
Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • InitiateOAuth: REFRESH.
  • OAuthVerifier: The verifier code.
  • OAuthClientId: (custom applications only) The Client Id in your custom OAuth application settings.
  • OAuthClientSecret: (custom applications only) The Client Secret in the custom OAuth application settings.
  • OAuthSettingsLocation: The location of the settings file where OAuth values are saved when you set InitiateOAuth to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'. When this connection property is set, the data persists across connections.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

  • InitiateOAuth: REFRESH.
  • OAuthClientId: (custom applications only) The client Id assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) The client secret assigned when you registered your application.
  • OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an Internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties:

  • OAuthClientId: (custom applications only) The client Id assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) The client secret assigned when you registered your application.
  • OAuthSettingsLocation: The location of your OAuth settings file. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Server-to-Server (OAuthClient)

When creating an application in Salesforce Marketing Cloud, you can select server-to-server authentication. In this case, the application's permissions are configured directly in the Salesforce Marketing Cloud UI. As such, there is no user context and hence no browser-based login or permission grants. For this scheme, you must create your own credentials.

Specify the following properties to enable server-to-server OAuth authentication for your application:

  • AuthScheme: OAuthClient.
  • InitiateOAuth: GETANDREFRESH.
  • OAuthClientId: The client Id.
  • OAuthClientSecret: The client secret.
  • Subdomain: Specify the Salesforce Marketing Cloud API subdomain.

User/Password Accounts (Basic)

The Salesforce Marketing Cloud SOAP API can connect using either your login credentials or OAuth authentication. Note that this authentication scheme is not available for REST API-based applications.

To connect to data using login credentials authentication, set the following:

  • AuthScheme: Basic.
  • User: The Salesforce Marketing Cloud user account.
  • Password: The password used to authenticate the user.
  • UseLegacyAuthentication: True.

Salesforce Marketing Cloud Connector for CData Sync

Selecting From Data Extensions in SalesforceMarketingCloud

The Sync App offers the possibility to select, insert, update, and delete data from data extensions as relational tables. To query a data extension, simple enter its name in the format DataExtensionObject_Name where Name is the name of your data extension.

Note: To connect to data extension objects in Salesforce Marketing Cloud, you must use the SOAP API. Set Schema to SOAP.

Selecting data from data extensions


SELECT * FROM DataExtensionObject_fsefes3

SELECT * FROM DataExtensionObject_fsefes3 WHERE FieldName1 = 'One'

Note 1: All filters which work with normal tables/views also work with data extensions.

Note 2: By default the Salesforce Marketing Cloud retrieves data for the LoggedIn ClientId. To retrieve results for more than one ClientID, use semi-colons (;) as a separator. The ClientID can be accounts and sub-accounts, including Enterprise 2.0, On-Your-Behalf, and Lock & Publish accounts.

SELECT * FROM DataExtensionObject_fsefes3 WHERE ClientID = '1234567'

Inserting data into data extensions


INSERT INTO DataExtensionObject_fsefes3 (FieldName1, FieldName2, FieldName3) VALUES ('One', 'Two', 'Three')

Updating data from data extensions


UPDATE DataExtensionObject_secondtest15 SET [Name] = 'ChangedFromTheApi' WHERE [Email Address] = '[email protected]'

Note: A primary key has to exist for this data extension for the update to work.

Deleting data from data extensions


DELETE FROM DataExtensionObject_secondtest15 WHERE [Email Address] = '[email protected]'

Note: A primary key has to exist for this data extension for the deletion to work.

Salesforce Marketing Cloud Connector for CData Sync

Advanced Features

This section details a selection of advanced features of the Salesforce Marketing Cloud Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Salesforce Marketing Cloud and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Salesforce Marketing Cloud Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Salesforce Marketing Cloud Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Salesforce Marketing Cloud Connector for CData Sync

Data Model

The CData Sync App models two Salesforce Marketing Cloud APIs as relational databases, the REST API and the SOAP API. Set the Schema property and use the information in each section to select the proper API based on your project needs.

Using the REST API

The REST API exposes broader access to Salesforce Marketing Cloud capabilities. All new Salesforce Marketing Cloud technologies implement REST API. See REST Data Model for the available entities in the REST API.

Using the SOAP API

The SOAP API provides comprehensive access to most email functionality. The SOAP API uses SOAP envelopes to pass information between you and Salesforce Marketing Cloud. See SOAP Data Model for the available entities in the SOAP API.

Salesforce Marketing Cloud Connector for CData Sync

REST Data Model

The Sync App models the Salesforce Marketing Cloud REST APIs as database Tables and Stored Procedures. These are defined in schema files, which are simple, text-based configuration files that make schemas easy to customize.

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

Tables describes the available tables. Tables are statically defined to model Assets, Categories, Journeys, and more.

Stored Procedures

Stored Procedures are function-like interfaces to Salesforce Marketing Cloud. Stored procedures allow you to execute operations to Salesforce Marketing Cloud, including downloading and uploading objects.

Salesforce Marketing Cloud Connector for CData Sync

Tables

The Sync App models the data in Salesforce Marketing Cloud as a list of tables in a relational database that can be queried using standard SQL statements.

Salesforce Marketing Cloud Connector for CData Sync Tables

Name Description
Assets Create, update, delete and query assets from your SalesForce Marketing Cloud account.
Callbacks Create, update, delete and query event notification callbacks
Campaigns Create, update, delete and query Campaigns.
Categories Create, update, delete and query categories(folders) in Content Builder.
EventDefinitions Create, delete and query event definitions.
FacebookMessengerProperties Query and create Facebook messenger properties.
JourneyActivities Create, update and query journey activities.
Journeys Create, update, delete and query journeys.
LineMessengerProperties Query and create Line messenger properties.
SendDefinitions Create, update, delete and query send definitions.
Subscriptions Create, update, delete and query event notification subscriptions.

Salesforce Marketing Cloud Connector for CData Sync

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

Insert

To create an Asset, you will need to specify at least the Name and TypeId column.

INSERT INTO ASSETS (TypeID, TypeName, Name) VALUES (207, 'templatebasedemail', 'First_Based_Template_Email_CData')

Update

Assets may be modified by providing the Id of the Asset and issuing an UPDATE statement.

UPDATE ASSETS SET Description = 'This is an updated asset.', Data = '
  "campaigns": {
    "campaigns": [
      {
        "campaignId": 12345,
        "campaignAssociationId": 2387
      }
    ]
  },
  "email": { } ... }'  WHERE ID = 19442

Delete

Assets may be deleted by providing the Id of the Asset and issuing a DELETE statement.

DELETE FROM ASSETS WHERE ID = 20027

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.

Salesforce Marketing Cloud Connector for CData Sync

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

Insert

To create a Callback, you will need to specify at least the CallbackName and Url column.

INSERT INTO [Callbacks] (CallbackName, Url) VALUES ('cb1', 'https://example.com')

Update

Callbacks may be modified by providing the CallbackId of the callback and issuing an UPDATE statement.

UPDATE [Callbacks] SET CallbackName = 'cb update' WHERE CallbackId = '34cd6cfe-5a21-4f3e-94c5-b6313a6954a4'

Delete

Callbacks may be deleted by providing the CallbackId of the callback and issuing a DELETE statement.

DELETE FROM [Callbacks] WHERE CallbackId = '43841979-7154-4fc4-9789-909dbba3a54f'

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.

Salesforce Marketing Cloud Connector for CData Sync

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'

Insert

To create a campaign, you will need to specify at least the Name column.

INSERT INTO [Campaigns] (Name, Description, CampaignCode, Color, Favorite) VALUES ('Test Camp', 'Test Description', 'tst 001', '0000ff', true)

Update

UPDATE operations are not supported for this table.

Delete

Campaigns may be deleted by providing the CampaignId of the campaign and issuing a DELETE statement.

DELETE FROM [Campaigns] WHERE Id = '5161'

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.

Salesforce Marketing Cloud Connector for CData Sync

Categories

Create, update, delete and query categories(folders) in Content Builder.

Table Specific Information

Select

Select all categories:

SELECT * FROM Categories

Retrieve all categories which have a specific ParentId:

SELECT * FROM Categories WHERE ParentId = 71839

Retrieve a specific category:

SELECT * FROM Categories WHERE Id = 94766

All the columns except SharedWith and SharingType can be sorted server side:

SELECT * FROM Categories ORDER BY Name ASC

Insert

To create a Category, you will need to specify at least the Name and ParentId column.

INSERT INTO Categories (Name, ParentId, categoryType) VALUES ('New New New Folder', 71839, 'asset')

Update

Categories may be modified by providing the Id of the category and issuing an UPDATE statement.

UPDATE Categories SET SharedWith = '333,555,888', SharingType = 'edit', EnterpriseId = 12345 WHERE Id = 71839

Delete

Categories may be deleted by providing the Id of the category and issuing a DELETE statement.

DELETE FROM Categories WHERE Id = 94843

Columns

Name Type ReadOnly References Filters Description
Id [KEY] Integer True =

The Id of the category(folder) in Content Builder.

Name String False

Name of the category.

ParentId Integer False =

ID of the parent category.

CategoryType String False

The type of category, either asset or asset-shared, which is automatically set to the CategoryType of the parent category. If set to asset-shared, include the SharingProperties in the call.

EnterpriseId Integer False

ID of the enterprise this business unit belongs to.

MemberId Integer False

ID of the member who creates the category.

SharedWith String False

List of up to 100 MID IDs the category is shared with. To share the category with all business units in the enterprise, and if your account has access to Content Builder Across Enterprise Sharing, set this to 0. SharedWith cannot contain 0 and other MIDs simultaneously. Since shared categories live in and are owned by the enterprise business unit, don't include the enterprise business unit in the SharedWith property.

SharingType String False

Indicates the permission that you are granting to the list of MIDs in sharedWith. The only possible value for categories is edit.

The allowed values are edit.

Description String False

Description of the category.

Salesforce Marketing Cloud Connector for CData Sync

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')

Insert

To create an event definition, you will need to specify at least the Name and Type column. DataExtensionId is also required. If you do not specify it, you must specify the Schema column.

INSERT INTO EventDefinitions (Type, Name, DataExtensionId, IsVisibleInPicker) VALUES ('Event', 'FirstEventDefinition', '74bc3342-eaca-e711-b98f-38eaa71427a1', true)

Delete

Event definitions may be deleted by providing the Id of the event definition and issuing a DELETE statement.

DELETE FROM EventDefinitions WHERE Id = 'f10efb9e-cb91-4fc9-be50-c20f00f7f255'

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.

Salesforce Marketing Cloud Connector for CData Sync

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'

Insert

To register a new facebook messenger property you must specify PageId, ApplicationId, ApplicationSecret, PageName, PageAccessToken, CallbackVerifyToken, EndpointUrl and ApiVersion:

INSERT INTO FacebookMessengerProperties (PageId, ApplicationId, ApplicationSecret, PageName, PageAccessToken, EndpointUrl, CallbackVerifyToken, ApiVersion) VALUES ('1732555047025799', '1093076390764037', '03d537gg656gvkbe9b430f002e9c4517', 'SFMC Engineers', 'someaccesstoken4fasdcruib213123knubkdnfisdubnu12312ub3pijnb', 'https://graph.facebook.com/v2.6/me/messages', 'this_is_the_verify_token', 'v2.0')

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.

Salesforce Marketing Cloud Connector for CData Sync

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

Insert

To create a new journey activity, you will need to specify at least the JourneyId, JourneyVersion, Type, Key, Arguments, ConfigurationArguments column.

INSERT INTO JourneyActivities (JourneyId, JourneyVersion, Type, Key, Arguments, ConfigurationArguments) VALUES ('4753026f-20b2-481b-89c5-fcd76ffa41f7', 1, 'WAIT', 'WAITBYDURATION-1', '{
  "waitEndDateAttributeDataBound": "",
  "waitDefinitionId": "f3de0c9a-5ff8-4f7b-84bd-9309ca337227",
  "waitForEventId": "",
  "executionMode": "{{Context.ExecutionMode}}",
  "startActivityKey": "{{Context.StartActivityKey}}",
  "waitQueueId": "{{Context.WaitQueueId}}"
}', '{
  "waitDuration": 1,
  "waitUnit": "DAYS",
  "specifiedTime": "",
  "timeZone": "",
  "description": "",
  "waitEndDateAttributeExpression": "",
  "specificDate": "",
  "waitForEventKey": ""
}')

Update

Journey activities may be modified by providing the Id, JourneyId, JourneyVersion and issuing an UPDATE statement.

UPDATE JourneyActivities SET Description = 'First_Journey_Activity_Description', Outcomes = '[
  {
    "key": "11bb2807-3f3d-4305-af51-547df032dbaf",
    "next": "WAITBYDURATION-1",
    "arguments": null,
    "metaData": null
  }
]' WHERE Id = 'fa4c3d81-8043-40e2-9741-22708d3a2e25' AND  JourneyId = '4753026f-20b2-481b-89c5-fcd76ffa41f7' AND 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.

Salesforce Marketing Cloud Connector for CData Sync

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

Insert

To create a new journey, you will need to specify at least the Name column.

INSERT INTO Journeys (Name) VALUES ('API-Created journey')

To create a new journey version, you will need to specify an existing journey key.

INSERT INTO Journeys (Name, Key) VALUES ('API-Created journey Version 3', '53bf5ea2-ff59-4c00-a23a-b1e9e333b80c')

Update

Journeys may be modified by providing the Id, Version of the journey and issuing an UPDATE statement.

UPDATE Journeys SET Name = 'API-Updated journey' WHERE Id = '257c51df-d6ed-4fb6-8fbc-70e63ed52b12' AND Version = 5

Delete

Journeys may be deleted by providing the Id of the journey and issuing a DELETE statement.

DELETE FROM Journeys WHERE Id = '53bf5ea2-ff59-4c00-a23a-b1e9e333b80c'

Journey versions may be deleted by providing the Id, Version of the journey and issuing a DELETE statement.

DELETE FROM Journeys WHERE Id = '257c51df-d6ed-4fb6-8fbc-70e63ed52b12' AND Version = 5

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.

Salesforce Marketing Cloud Connector for CData Sync

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'

Insert

To register a new line messenger property you must specify ChannelId, ChannelName, ChannelSecret, IsTransactional, IsTestChannel, EndpointUrl and ApiVersion:

INSERT INTO LineMessengerProperties (ChannelId, ChannelName, ChannelSecret, EndpointUrl, IsTransactional, IsTestChannel, IsActive, ApiVersion) VALUES ('23493453984234345', 'SFMC Engineers', '03d537gg656gvkbe9b430f002e9c4517', 'https://example.com/1732555047025799', true, false, true, 'v2.0')");

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.

Salesforce Marketing Cloud Connector for CData Sync

SendDefinitions

Create, update, delete and query send definitions.

Table Specific Information

Select

Retrieve all send definitions:

SELECT * FROM SendDefinitions

Retrieve a specific send definition:

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

Retrieve all send definitions with Status as 'Active':

SELECT * FROM SendDefinitions WHERE Status = 'Active'

Insert

To create a send definition, you will need to specify at least the DefinitionKey, Name, SubscriptionsList and ContentCustomerKey column.

INSERT INTO SendDefinitions (DefinitionKey, Name, ContentCustomerKey, SubscriptionsList, OptionsCc, OptionsCreateJourney) VALUES ('TEST_Definition_Key', 'Test Definition Key', '76ad3572-abbc-4baa-b3fe-04c4364bf34a', 'All Subscribers', '[email protected]', true)

Update

To update a send definition, you will need to specify the DefinitionKey of the SendDefinition.

UPDATE SendDefinitions SET OptionsCc = '[email protected],[email protected]', OptionsBcc = '[email protected],[email protected]' WHERE DefinitionKey = 'TEST_Definition_Key'

Delete

Send definitions may be deleted by providing the Definition Key of the send definition and issuing a DELETE statement.

DELETE FROM SendDefinitions WHERE DefinitionKey = 'TEST_Definition_Key'

Columns

Name Type ReadOnly References Filters Description
DefinitionKey [KEY] String False =

Unique, user-generated key to access the definition object.

DefinitionId String True

Unique Marketing Cloud object identifier.

Classification String False

Marketing Cloud external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional.

ContentCustomerKey String False

Unique identifier of the content asset.

CreatedDate Datetime True

Date the definition was created.

Description String False

User-provided description of the send definition.

Journey Boolean True

Indicates whether the send definition is available in Journey Builder as a Transactional Send Journey.

JourneyInteractionKey String True

Unique ID of the Transactional Send Journey.

ModifiedDate Datetime True

Date and time the definition was most recently changed.

Name String False

Name of the definition.

OptionsBcc String False

Include BCC email addresses with every send. To dynamically BCC at send time, create a profile attribute and use the %%attribute%% syntax.

OptionsCc String False

Include CC email addresses with every send. To CC dynamically at send time, create a profile attribute and use the %%attribute%% syntax.

OptionsTrackLinks Boolean False

Wraps links for tracking and reporting. Default is true.

OptionsCreateJourney Boolean False

Defines the subscriber key or email address within a data extension. Required when defining a schema.

RequestId String True

The unique identifier of this request.

Status String False =,!=

Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn't processed or delivered. Instead, the message is queued for later processing for up to three days.

SubscriptionsAutoAddSubscriber Boolean False

Adds the recipient's email address and contact key as a subscriber key to subscriptions.list. Default is true.

SubscriptionsDataExtension String False

Marketing Cloud external key of the triggered send data extension. Each request inserts as a new row in the data extension.

SubscriptionsList String False

Marketing Cloud external key of the list or all subscribers. Contains the subscriber keys and profile attributes.

SubscriptionsUpdateSubscriber Boolean False

For email only: Updates the recipient's contact key as a subscriber key with the provided email address and profile attributes to subscriptions.list. Default is true.

Salesforce Marketing Cloud Connector for CData Sync

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

Insert

To create a subscription, you will need to specify at least the SubscriptionName, CallbackId and EventCategoryTypes column.

INSERT INTO [Subscriptions] (SubscriptionName, CallbackId, EventCategoryTypes) VALUES ('sajli subscription', '6fb0758b-155d-4968-869d-7a4f5a3ad2fe', '[\"TransactionalSendEvents.EmailNotSent\", \"TransactionalSendEvents.EmailSent\"]')

Update

Subscriptions may be modified by providing the SubscriptionId and the EventCategoryTypes column of the subscription and issuing an UPDATE statement.

UPDATE [Subscriptions] SET Status = 'paused', EventCategoryTypes = '[\"TransactionalSendEvents.EmailNotSent\", \"TransactionalSendEvents.EmailSent\"]' WHERE SubscriptionId = 'db1e2af0-807d-463b-96e8-fe3aaa019fdb'

Delete

Subscriptions may be deleted by providing the SubscriptionId of the subscription and issuing a DELETE statement.

DELETE FROM [Subscriptions] WHERE SubscriptionId = '43841979-7154-4fc4-9789-909dbba3a54f'

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.

Salesforce Marketing Cloud Connector for CData Sync

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Salesforce Marketing Cloud Connector for CData Sync Views

Name Description
AssetTypes Get all available asset types in Salesforce Marketing Cloud.
CampaignAssets Retrieve all campaign assets in Salesforce Marketing Cloud.
Contact Retrieve contacts in Salesforce Marketing Cloud.
Contacts Retrieve all contacts in Salesforce Marketing Cloud.
JourneyAuditLogs Retrieves an audit log of a journey and its versions.
JourneyHistory Retrieves the history of a journey. Record access cannot exceed 1 GB of file size data.
SmsStatusCodes Query sms status codes.
TransactionalMessages Gets a paginated list of messages that were not sent, ordered from oldest to newest.

Salesforce Marketing Cloud Connector for CData Sync

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.

Salesforce Marketing Cloud Connector for CData Sync

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.

Salesforce Marketing Cloud Connector for CData Sync

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.

Salesforce Marketing Cloud Connector for CData Sync

Contacts

Retrieve all contacts in Salesforce Marketing Cloud.

Table Specific Information

Select

Retrieve all contacts:

SELECT * FROM Contacts
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
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

Salesforce Marketing Cloud Connector for CData Sync

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.

Salesforce Marketing Cloud Connector for CData Sync

JourneyHistory

Retrieves the history of a journey. Record access cannot exceed 1 GB of file size data.

Table Specific Information

Select

Retrieves information about a specific contact, journey, or journey version:

SELECT * FROM JourneyHistory

Retrieves information about a specific contact, journey, or journey version within the specified date range.:

SELECT * FROM JourneyHistory where StartDate='2022-09-01T10:29:22.438Z' and EndDate = '2022-09-30T11:29:22.438Z'

NOTE: A maximum of 10k records can be retrieved using JourneyHistory. If only StartDate is mentioned, it will retrieve a maximum of 10k records from the StartDate. If both StartDate and EndDate are mentioned, it will fetch the first 10k records.

Columns

Name Type References Description
Id String A unique identifier for this journey history that is generated and assigned by the journey API when the journey is in running state.
ActivityId String A unique identifier for this activity that is generated and assigned by the journey API when the activity is created.
ActivityName String The activity name.
ActivityType String The type of activity.
ClientStatus String The client status.
ContactKey String The customer key (also a unique identifier within the MID) for this journey.
CreatedDate Datetime The datetime when the journey was created.
DefinitionId String The definition Id.
DefinitionInstanceId String The definition instance Id.
DefinitionName String The definition name.
EndDate Datetime The end datetime value.
EntrySource String The entry source.
EpochTimeInMilliseconds Long The epoch time in milliseconds.
EventId String The event Id.
EventName String The event name.
LongId String The long Id.
Mid String The Marketing Cloud member Id (MID).
Message String The message.
OutcomeActivityId String The outcome activity Id.
ResultMessages String The result messages.
ResultOutcomes String The result outcomes.
ResultStatus String The result status.
ResultTags String The result tags.
SourceType String The source type.
StartDate Datetime The start datetime value.
Status String The status of the journey history.
TransactionTime Datetime The transaction datetime.

Salesforce Marketing Cloud Connector for CData Sync

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.

Salesforce Marketing Cloud Connector for CData Sync

TransactionalMessages

Gets a paginated list of messages that were not sent, ordered from oldest to newest.

Table Specific Information

Select

Select all TransactionalMessages:

SELECT * FROM TransactionalMessages

Columns

Name Type References Description
LastEventId Integer The ID of the Event from which you want the response to start.
StatusCode Integer Integer value of the reason the send did not complete. Review Email Send Error Codes for more information.
StatusMessage String The reason the send did not complete. Review Email Send Error Codes for more information.
EventCategoryType String TransactionalSendEvent event type. EmailSent indicates that the email was sent to the email provider. EmailNotSent indicates that the email was not sent and includes the reason. EmailQueued indicates that the email has not yet been processed for sending.
Timestamp String Time the event occured in Central Standard Time (no daylight savings)
DefinitionKey String Unique identifier of the definition.
EventId Integer Numeric identifier of the event.
MessageKey String Unique identifier to track message send status.
ContactKey String Unique identifier for a subscriber in Marketing Cloud.
To String Channel address of the recipient. For email, it’s the recipient's email address. For SMS, it’s the recipient's mobile number.

Salesforce Marketing Cloud Connector for CData Sync

SOAP Data Model

The Sync App models the Salesforce Marketing Cloud SOAP APIs as database Tables and Views. These are defined in schema files, which are simple, text-based configuration files that make schemas easy to customize.

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

Tables describes the available tables. Tables are statically defined to model Assets, Categories, Journeys, and more.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views. Stored procedures allow you to execute operations to Salesforce Marketing Cloud, including downloading and uploading objects.

Salesforce Marketing Cloud Connector for CData Sync

Tables

The Sync App models the data in Salesforce Marketing Cloud as a list of tables in a relational database that can be queried using standard SQL statements.

Salesforce Marketing Cloud Connector for CData Sync Tables

Name Description
Account A Marketing Cloud account.
AccountUser An individual user within an account. This table does not support deletes.
BusinessUnit A unit within a larger Enterprise or Enterprise 2.0 account. This table supports queries and updates only.
ContentArea A ContentArea represents a defined section of reusable content.
DataExtension Represents a data extension within an account.
Email Represents an email in a Marketing Cloud account.
EmailSendDefinition Record that contains the message information, sender profile, delivery profile, and audience information.
FileTrigger Reserved for future use. This table does not suport deletes.
FilterDefinition Defines an audience based on specified rules in a filter. This table does not support inserts.
ImportDefinition Defines a reusable pattern of import options. This table does not support inserts.
List A marketing list of subscribers.
Portfolio Indicates a file within the Portfolio of a Marketing Cloud account.
ProgramManifestTemplate Reserved for future use. This table does not support deletes or inserts.
QueryDefinition Represents a SQL query activity accessed and performed by the SOAP API. This table does not support updates or inserts.
ReplyMailManagementConfiguration Details configuration settings for the reply mail management in an account. This table does not support deletes.
Send Used to send email and retrieve aggregate data. This table does not support deletes or updates.
SendClassification Represents a send classification in a Marketing Cloud account.
SenderProfile The send profile used in conjunction with an email send definition.
SMSTriggeredSend Indicates a single instance of an SMS triggered send. This table does not support deletes or updates.
Subscriber A person subscribed to receive email or SMS communication.
SuppressionListDefinition A suppression list that can be associated with different contexts.
TriggeredSendDefinition To create or update a TriggeredSendDefinition where the list ID is the All Subs List ID, you need the Email | Subscribers | All Subscribers | View and SendEmailToList permissions.

Salesforce Marketing Cloud Connector for CData Sync

Account

A Marketing Cloud account.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Account WHERE Id = 123

SELECT * FROM Account WHERE Id IN (123, 456)

SELECT * FROM Account WHERE CreatedDate > '2017/01/25'

Insert

You must specify the Name column when executing an insert against this table.

INSERT INTO Account (Name) VALUES ('Test')

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Account SET Fax = '1123123' WHERE Id = 123

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Account WHERE Id = 123

Columns

Name Type ReadOnly Description
ID [KEY] Int False

Identifier of the account.

AccountType String False

Type of Marketing Cloud account.

The allowed values are BUSINESS_UNIT, CHANNEL_CONNECT, CONNECT, DOTO_MEMBER, ENTERPRISE_2, EXACTTARGET, LP_MEMBER, None, PRO_CONNECT, PRO_CONNECT_CLIENT.

ParentID Int False

Specifies the ID number of the parent account for Lock and Publish, On Your Behalf, Enterprise, and Enterprise 2.0 account children and business units.

BrandID Int False

Specifies brand tags to use on an account.

PrivateLabelID Int False

Specifies the private label for an account.

ReportingParentID Int False

Reserved for future use.

Name String False

Name of the account.

Email String False

Default email address the account. Indicates if subscriber information can be used for email sends.

FromName String False

Specifies the default email message From Name. Deprecated for email send definitions and triggered send definitions.

BusinessName String False

Business name of an account's owner.

Phone String False

Specifies a phone number.

Address String False

The address used to communicate with a Person.

Fax String False

Fax number of the account's owner.

City String False

City of an account's owner to be displayed in the physical mailing address required at the bottom of all email messages.

State String False

Specifies the geographical state of the account's owner.

Zip String False

Specifies the zip code of the account's owner.

Country String False

Country of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages.

IsActive Boolean False

Specifies whether or not the account is active.

IsTestAccount Bool False

Specifies whether or not an account is a 'Test' account.

Client_ClientID1 Int True

The Client Id of the client.

DBID Int False

Reserved for future use.

CustomerID Long False

Reserved for future use.

DeletedDate Datetime True

Date and time of an account's deletion.

EditionID Int False

Specifies the product edition of the account.

ModifiedDate Datetime False

Indicates the last time account information was modified.

CreatedDate Datetime False

Date and time of the account's creation.

ParentName String False

Specifies the name of the Parent account.

Subscription_SubscriptionID String True

Reserved for future use.

Subscription_HasPurchasedEmails Bool True

Reserved for future use.

Subscription_EmailsPurchased Int True

Specifies the number of emails purchased in a subscription.

Subscription_Period String True

Reserved for future use.

Subscription_AccountsPurchased Int True

Marketing Cloud Accounts purchased.

Subscription_LPAccountsPurchased Int True

Specifies the number of Lock and Publish account purchased.

Subscription_DOTOAccountsPurchased Int True

Specifies number of Marketing Cloud agency reseller accounts purchased.

Subscription_BUAccountsPurchased Int True

Defines the number of business units purchased for a subscription.

Subscription_AdvAccountsPurchased Int True

This property represents the number of advertising accounts purchased for the account.

Subscription_BeginDate Datetime True

Specifies the date a subscription begins.

Subscription_EndDate Datetime True

Specifies the end data of an activity.

Subscription_Notes String True

Deprecated.

PartnerKey String False

Unique identifier provided by partner for an account, accessible only via API.

Client_PartnerClientKey String True

The partner client key of the client.

InheritAddress Bool False

Specifies that an Enterprise 2.0 business unit will inherit the address from the parent business unit.

UnsubscribeBehavior Int True

The behavior of the subscription when unsubscripbed.

Subscription_ContractNumber String True

Reserved for future use.

Subscription_ContractModifier String True

Reserved for future use.

IsTrialAccount Bool False

Reserved for future use.

Client_EnterpriseID Long True

Read-only identifier the enterprise of the client.

ParentAccount_ID Int False

Read-only identifier for the parent of the account.

ParentAccount_Name String True

Name of the parent of the account.

ParentAccount_ParentID Int True

Read-only identifier for the parent of the parent of this account.

ParentAccount_CustomerKey String True

The customer key of the parent account.

ParentAccount_AccountType String True

The account type of the parent account.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Locale_LocaleCode String True

The locale code of the locale.

TimeZone_ID Int True

Read-only identifier of the timezone.

TimeZone_Name String True

Name of the timezone.

Roles String False

Collection of roles defined for an account.

ContextualRoles Int True

The contextual roles of the account.

ObjectState String False

Reserved for future use.

LanguageLocale_LocaleCode String True

The locale code of the language layout.

IndustryCode String False

The code of the industry.

AccountState Int False

The state of the account.

SubscriptionRestrictionFlags Long False

Restriction flags of the subscription.

Salesforce Marketing Cloud Connector for CData Sync

AccountUser

An individual user within an account. This table does not support deletes.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM AccountUser WHERE Id = 123

SELECT * FROM AccountUser WHERE Id IN (123, 456)

SELECT * FROM AccountUser WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Client_Id, Name, Email, UserID, and Password.

INSERT INTO AccountUser (Client_Id, UserId, Name, Email, Password) VALUES (123, 'bcabsbasbcasb', 'Test', '[email protected]', 'testpas@2sowrd')

Update

You must specify the Id and the Client_Id in the WHERE clause when executing an update against this table.

UPDATE AccountUser SET Name = 'changed' WHERE Id = 123 AND Client_Id = 456

Columns

Name Type ReadOnly Description
ID [KEY] Int False

Identifier for an object.

CreatedDate Datetime False

Date and time of the object's creation..

ModifiedDate Datetime False

Indicates the last time object information was modified.

Client_ID [KEY] Int False

The Id of the client.

AccountUserID Int False

Specifies the Marketing Cloud identifier of an account user.

UserID String False

The Id of the user.

Name String False

Name of the object or property.

Email String False

Default email address for object. Indicates if subscriber information can be used for email sends.

MustChangePassword Bool False

Indicates whether user must change password on next login.

ActiveFlag Bool False

Specifies the status of an account user.

ChallengePhrase String False

Specifies the challenge answer for login assistance.

ChallengeAnswer String False

Specifies the challenge answer for login assistance.

IsAPIUser Bool False

Indicates if a user can use the API. A value of true indicates the user's password remains the same until actively changed.

NotificationEmailAddress String False

Indicates email address to which to send notifications.

Client_PartnerClientKey String False

The partner client key of the partner.

Password String False

Specified the password of an account user.

Locale_LocaleCode String True

The locale code of the locale.

TimeZone_ID Int True

The id of the timezone.

TimeZone_Name String True

The name of the timezone.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

DefaultBusinessUnit Int False

Indicates business unit account user initially accesses.

LanguageLocale_LocaleCode String True

The locale code of the language locale.

Client_ModifiedBy Int False

Returns user ID for user who modified the object.

Salesforce Marketing Cloud Connector for CData Sync

BusinessUnit

A unit within a larger Enterprise or Enterprise 2.0 account. This table supports queries and updates only.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM BusinessUnit WHERE Id = 123

SELECT * FROM BusinessUnit WHERE Id IN (123, 456)

SELECT * FROM BusinessUnit WHERE CreatedDate > '2017/01/25'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE BusinessUnit SET Name = 'Changed' WHERE Id = 123

Columns

Name Type ReadOnly Description
ID [KEY] Int False

Identifier for an object.

AccountType String False

Type of Marketing Cloud account. Valid values are BUSINESS_UNIT, CHANNEL_CONNECT, CONNECT, DOTO_MEMBER, ENTERPRISE_2, EXACTTARGET, LP_MEMBER, None, PRO_CONNECT, PRO_CONNECT_CLIENT.

ParentID Int False

Specifies the ID number of the parent account.

BrandID Int False

Specifies brand tags to use on an account.

PrivateLabelID Int False

Specifies the private label for an account.

ReportingParentID Int False

Reserved for future use..

Name String False

Name of the object or property.

Email String False

Default email address for object.

FromName String False

Specifies the default email message From Name.

BusinessName String False

Business name of an account's owner.

Phone String False

Specifies a phone number.

Address String False

The address used to communicate with a Person.

Fax String False

Fax number of the account's owner.

City String False

City of an account's owner to be displayed in the physical mailing address required at the bottom of all email messages.

State String False

Specifies the geographical state of the account's owner.

Zip String False

Specifies the zip code of the account's owner.

Country String False

Country of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages.

IsActive Bool False

Specifies whether or not the object is active.

IsTestAccount Bool False

Specifies whether or not an account is a 'Test' account.

Client_ID Int False

The Id of the client.

DBID Int False

Reserved for future use.

CustomerID Long False

The Id of the customer.

DeletedDate Datetime False

Date and time of an account's deletion (the value of this property must be set before the account can be deleted).

EditionID Int False

Specifies the product edition of the account.

IsTrialAccount Bool False

Reserved for future use.

Locale_LocaleCode String True

The locale code of the locale.

Client_EnterpriseID Long True

The enterprise Id of the client.

ModifiedDate Datetime False

Indicates the last time object information was modified.

CreatedDate Datetime False

Date and time of the object's creation.

Subscription_SubscriptionID String True

The subscription id of the subscription.

Subscription_HasPurchasedEmails Bool True

Reserved for future use..

Subscription_EmailsPurchased Int True

Specifies the number of emails purchased in a subscription..

Subscription_Period String True

Reserved for future use..

Subscription_AccountsPurchased Int True

Marketing Cloud Accounts purchased.

Subscription_LPAccountsPurchased Int True

Specifies the number of Lock and Publish account purchased.

Subscription_DOTOAccountsPurchased Int True

Specifies number of Marketing Cloud agency reseller accounts purchased.

Subscription_BUAccountsPurchased Int True

Defines the number of business units purchased for a subscription.

Subscription_AdvAccountsPurchased Int True

This property represents the number of advertising accounts purchased for the account.

Subscription_BeginDate Datetime True

Specifies the date a subscription begins..

Subscription_EndDate Datetime True

Specifies the end data of an activity..

Subscription_Notes String True

Deprecated..

Subscription_ContractNumber String True

Reserved for future use..

Subscription_ContractModifier String True

Reserved for future use..

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

Client_PartnerClientKey String True

Unique identifier provided by partner for an object, accessible only via API.

ParentName String False

Specifies the name of the Parent account.

ParentAccount_ID Int True

The Id of the parent account.

ParentAccount_Name String True

The name of the parent account.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Description String False

Describes and provides information regarding the object.

DefaultSendClassification_ObjectID String True

System-controlled, read-only text string identifier for object.

DefaultHomePage_ID String True

The Id of the default home page..

InheritAddress Bool False

Specifies that an Enterprise 2.0 business unit will inherit the address from the parent business unit.

ContextualRoles Int True

The contextual roles of the business unit.

LanguageLocale_LocaleCode String True

The locale code of the language locale.

Salesforce Marketing Cloud Connector for CData Sync

ContentArea

A ContentArea represents a defined section of reusable content.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ContentArea WHERE Id = 123

SELECT * FROM ContentArea WHERE Id IN (123, 456)

SELECT * FROM ContentArea WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name and Content.

INSERT INTO ContentArea (Name, Content) VALUES ('Testing', 'Hello world')

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE ContentArea SET Name = 'Changed' WHERE Id = 123

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM ContentArea WHERE Id = 123

Columns

Name Type ReadOnly Description
RowObjectID String False

Identifier for the row of an object.

ObjectID String False

System-controlled, text string identifier for object.

ID [KEY] Int False

Identifier for an object.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Client_ID Int False

The Id of the client.

ModifiedDate Datetime False

Indicates the last time object information was modified.

CreatedDate Datetime False

Date and time of the object's creation.

CategoryID Int False

Specifies the identifier of the folder containing the email.

Name String False

Name of the object or property.

Layout String False

Indicates layout type of content area.

IsDynamicContent Bool False

Indicates if specific content area contains dynamic content.

Content String False

Identifies content contained in a content area.

IsSurvey Bool False

Indicates whether a specific content area contains survey questions.

IsBlank Bool False

Indicates if specified content area contains no content.

Key String False

Specifies key associated with content area in HTML body.

Salesforce Marketing Cloud Connector for CData Sync

DataExtension

Represents a data extension within an account.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataExtension WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name, CustomerKey, and Fields.

Note: The Salesforce Marketing Cloud APIs have problems with DataExtensions with names longer than 40 characters. Try to limit the name to something relatively short.

INSERT INTO DataExtension (Name, CustomerKey, Fields) VALUES ('TestName', 'TestCustomerKey', 'fieldname1;fieldname2;fieldname3')

Update

You must specify the ObjectId or CustomerKey or Name in the WHERE clause when executing an update against this table.

UPDATE DataExtension SET ResetRetentionPeriodOnImport = true WHERE ObjectId = 'nzxcaslkjd-123'

Delete

You must specify the ObjectId or CustomerKey or Name in the WHERE clause when executing a delete against this table.

DELETE FROM DataExtension WHERE ObjectId = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
ObjectID [KEY] String False

System-controlled, text string identifier for object.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Name String False

Name of the object or property.

CreatedDate Datetime False

Date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Client_ID Int False

The Id of the client.

Description String False

Describes and provides information regarding the object.

IsSendable Bool False

Indicates whether you can use a data extension as part of an audience for a message send.

IsTestable Bool False

Indicates whether a sendable data extension can be used within tests sends for a message.

SendableDataExtensionField_Name String False

The name of the sendable data extension field.

SendableSubscriberField_Name String False

The name of the sendablesubscriber field.

Template_CustomerKey String False

User-supplied unique identifier for an object within an object type.

CategoryID Long False

Specifies the identifier of the folder.

Status String False

Defines status of the object.

IsPlatformObject Bool False

Indicated whether the object is a platform object.

DataRetentionPeriodLength Int False

Specifies the number of time units for which data will be retained.

DataRetentionPeriodUnitOfMeasure Int False

Specifies the units of time for which data will be retained.

RowBasedRetention Bool False

Indicates whether the data retention policy removes data by row or by entire data extension.

ResetRetentionPeriodOnImport Bool False

Indicates whether a data retention period should be reset after a successful import of new data.

DeleteAtEndOfRetentionPeriod Bool False

Indicates whether data should be deleted at the end of the retention period.

RetainUntil String False

Indicates the date that ends the retention period for a data extension.

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
Fields String

A semi-colon separated list of names for the fields to add to this data entension.

Salesforce Marketing Cloud Connector for CData Sync

Email

Represents an email in a Marketing Cloud account.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Email WHERE Id = 123

SELECT * FROM Email WHERE Id IN (123, 456)

SELECT * FROM Email WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name and Subject.

INSERT INTO Email (Name, Subject) VALUES ('Testing', 'Greetings')

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Email SET Name = 'Changed' WHERE Id = 31558

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Email WHERE Id = 123

Columns

Name Type ReadOnly Description
ID [KEY] Int False

Identifier for an object.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

CreatedDate Datetime False

Indicates the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Client_ID Int False

The Id of the client.

Name String False

Name of the object or property.

PreHeader String False

Contains text used in preheader of email message on mobile devices.

Folder String False

Specifies folder information (Retrieve only) - Deprecated.

CategoryID Int False

Specifies the identifier of the folder containing the email.

HTMLBody String False

Contains HTML body of an email message.

TextBody String False

Contains raw text body of a message.

Subject String False

Defines the subject of an object.

IsActive Bool False

Specifies whether or not the object is active.

IsHTMLPaste Bool False

Indicates whether email message was created via pasted HTML.

ClonedFromID Int False

ID of email message from which the specified email message was created.

Status String False

Defines the status of an object.

EmailType String False

Defines the preferred email type.

CharacterSet String False

Indicates encoding used in an email message.

HasDynamicSubjectLine Bool False

Indicates whether email message contains a dynamic subject line.

ContentCheckStatus String False

Indicates whether content validation has completed for this email message.

Client_PartnerClientKey String False

User-defined partner key for an account.

ContentAreas String False

Contains information on content areas included in an email message.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Salesforce Marketing Cloud Connector for CData Sync

EmailSendDefinition

Record that contains the message information, sender profile, delivery profile, and audience information.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM EmailSendDefinition WHERE ObjectID = 123

SELECT * FROM EmailSendDefinition WHERE ObjectID IN (123, 456)

SELECT * FROM EmailSendDefinition WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name, SendClassification_CustomerKey, and Email_Id.

INSERT INTO EmailSendDefinition (Name, SendClassification_CustomerKey, Email_Id) VALUES ('Testing', 13507, 31677)

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE EmailSendDefinition SET Description = 'Changed' WHERE ObjectId = 'acasascas'

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM EmailSendDefinition WHERE ObjectId = 'sdfsdf123'

Columns

Name Type ReadOnly Description
Client_ID Int True

The Id of the client.

CreatedDate Datetime False

Indicates the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

ObjectID String False

System-controlled, text string identifier for object.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Name String False

Name of the object or property.

CategoryID Int False

Specifies the identifier of the folder containing the email.

Description String False

Describes and provides information regarding the object.

SendClassification_CustomerKey String False

User-supplied unique identifier for an object within an object type.

SenderProfile_CustomerKey String True

User-supplied unique identifier for an object within an object type

SenderProfile_FromName String True

Specifies the default email message From Name.

SenderProfile_FromAddress String True

Indicates From address associated with a object.

DeliveryProfile_SourceAddressType String True

Indicates the source IP address type used with the delivery profile.

DeliveryProfile_PrivateIP String True

Contains information on the private IP address associated with a delivery profile.

DeliveryProfile_DomainType String True

Defines the type of domain.

DeliveryProfile_PrivateDomain String True

Defines private domain to use as part of a delivery profile or send definition.

DeliveryProfile_HeaderSalutationSource String True

Defines source of header salutation for a delivery profile or send definition.

DeliveryProfile_FooterSalutationSource String True

Defines source of a footer salutation to use as part of a delivery profile or send definition (Default, ContentLibrary, or None).

SuppressTracking Bool False

Indicates whether the send definition suppresses tracking results for associated sends.

IsSendLogging Bool False

Indicates whether send logging is enabled for the specified send definition

Email_ID Int True

The Id of the email.

CCEmail String False

Carbon copy email address.

BccEmail String False

Indicates email addresses to receive blind carbon copy of a message.

AutoBccEmail String False

Defines blind carbon copy email address to which to send a message as part of an email send definition.

TestEmailAddr String False

Defines an email address to which to send a test message as part of an email send definition.

EmailSubject String False

Subject of the email.

DynamicEmailSubject String False

Contains content to be used in a dynamic subject line.

IsMultipart Bool False

Indicates whether the email is sent with Multipart/MIME enabled.

IsWrapped Bool False

Indicates whether an email send contains the links necessary to process tracking information for clicks.

SendLimit Int False

Indicates limit of messages to send as part of a send definition within a predefined send window.

DeduplicateByEmail Bool False

Indicates whether a send definition should de-duplicate multiple emails sent to the same email address.

ExclusionFilter String False

Contains a string of AMPscript that can evaluate to true or false, used to exclude email addresses from a send definition.

Additional String False

The ID for a send that customers use as a campaign ID.

IsPlatformObject Bool False

Indicated whether the object is a platform object.

Salesforce Marketing Cloud Connector for CData Sync

FileTrigger

Reserved for future use. This table does not suport deletes.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) query is processed server side:

SELECT * FROM FileTrigger WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name.

INSERT INTO FileTrigger (Name) VALUES ('Testing')

Update

You must specify the ObjectId in the WHERE clause when executing an update against this table.

UPDATE FileTrigger SET Name = 'Changed' WHERE ObjectId = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
ObjectID [KEY] String False

System-controlled, text string identifier for object.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Client_ID Long False

The Id of the client.

ExternalReference String False

Reserved for future use.

Name String False

Name of the object or property.

Description String False

Describes and provides information regarding the object.

Type String False

Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master.

Status String False

Defines status of the object.

StatusMessage String False

Describes the status of an API call.

RequestParameterDetail String False

Reserved for future use.

ResponseControlManifest String False

Reserved for future use.

FileName String False

Indicates name of file associated with the object.

LastPullDate Datetime False

Reserved for future use.

ScheduledDate Datetime False

Reserved for future use.

IsActive Bool False

Specifies whether or not the object is active.

CreatedDate Datetime False

Indicated the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Client_CreatedBy Int False

Returns user ID for user who created object

Client_ModifiedBy Int False

Returns user ID for user who modified object.

Salesforce Marketing Cloud Connector for CData Sync

FilterDefinition

Defines an audience based on specified rules in a filter. This table does not support inserts.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) query is processed server side:

SELECT * FROM FilterDefinition WHERE CreatedDate > '2017/01/25'

Update

You must specify the ObjectId in the WHERE clause when executing an update against this table.

UPDATE FilterDefinition SET Name = 'Changed' WHERE ObjectId = 'nzxcaslkjd-123'

Delete

You must specify the ObjectId in the WHERE clause when executing a delete against this table.

DELETE FROM FilterDefinition WHERE Object = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
ObjectID [KEY] String False

System-controlled, text string identifier for object.

Client_ID Int True

The Id of the client.

Client_ClientPartnerKey Int True

User-defined partner key for an account.

Name String False

Name of the object or property.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

CreatedDate Datetime False

Indicated the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Description String False

Describes and provides information regarding the object.

DataSource_ID Int True

Read-only identifier for an object.

DataSource_ObjectID String True

System-controlled, read-only text string identifier for object.

DataSource_Name Int True

Name of the object or property.

DataSource_ListName Int True

The list name of the data source.

DataSource_CustomerKey String True

User-supplied unique identifier for an object within an object type.

DataSource_CreatedDate Datetime True

Read-only date and time of the object's creation.

DataSource_ModifiedDate Datetime True

Indicates the last time object information was modified.

DataFilter String False

Filter parts for a filter definition.

Salesforce Marketing Cloud Connector for CData Sync

ImportDefinition

Defines a reusable pattern of import options. This table does not support inserts.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ImportDefinition WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM ImportDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM ImportDefinition WHERE CreatedDate > '2017/01/25'

Update

You must specify the ObjectId in the WHERE clause when executing an update against this table.

UPDATE ImportDefinition SET Name = 'Changed' WHERE ObjectId = 'nzxcaslkjd-123'

Delete

You must specify the ObjectId in the WHERE clause when executing a delete against this table.

DELETE FROM ImportDefinition WHERE ObjectId = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
ObjectID [KEY] String False

System-controlled, text string identifier for object.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

Client_ClientID1 Int False

The client Id of the client.

Name String False

Name of the object or property.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Description String False

Describes and provides information regarding the object.

FileSpec String False

Defines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%).

AllowErrors Bool False

Specifies whether an import should continue after an error occurs.

FieldMappingType String False

Defines how fields are mapped within an import definition.

FileType String False

Specifies column delimiter of a file (CSV, TAB, or Other).

UpdateType String False

Indicates update type associated with an import definition.

MaxFileAge Int False

Specifies the age of the oldest file to be included in an import definition.

MaxFileAgeScheduleOffset Int False

Specifies an offset in hours to associate with a file age for accomodating timezone differences.

MaxImportFrequency Int False

Specifies the number of hours to wait before allowing a file to be imported again.

DestinationObject_ID Int False

Identifier for an object.

DestinationObject_ObjectID String False

System-controlled, text string identifier for object.

Notification_ResponseType String True

The response type of the notification.

Notification_ResponseAddress String False

The response address of the notification.

RetrieveFileTransferLocation_ObjectID String False

System-controlled, text string identifier for object.

Delimiter String False

Specifies the delimiter used as part of an import definition.

HeaderLines Int False

Specifies the number of lines in the file that are header lines that should not be processed.

EndOfLineRepresentation String False

Specifies the line-ending character(s) used in delimited files to be imported.

NullRepresentation String False

Defines character used to represent a null value during an import.

StandardQuotedStrings Bool False

Specifies whether standard quoted strings are used as part of an import definition.

DateFormattingLocale_LocaleCode String False

The locale code of the date formatting locale.

Salesforce Marketing Cloud Connector for CData Sync

List

A marketing list of subscribers.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM List WHERE Id = 123

SELECT * FROM List WHERE Id IN (123, 456)

SELECT * FROM List WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following field when inserting to this table: ListName.

INSERT INTO List (ListName) VALUES ('Test')

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE List SET ListName = 'Changed' WHERE Id = 123

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM List WHERE Id = 123

Columns

Name Type ReadOnly Description
ID [KEY] Int False

Identifier for an object.

ObjectID String False

System-controlled, text string identifier for object.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

CreatedDate Datetime False

Indicates the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Client_ID Int False

The Id of the client.

Client_PartnerClientKey String False

User-defined partner key for an account.

ListName String False

Name of a specific list.

Description String False

Describes and provides information regarding the object.

Category Int False

ID of the folder that an item is located in.

Type String False

Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

ListClassification String True

Specifies the classification for a list.

AutomatedEmail_ID Int False

Identifier for an object.

Salesforce Marketing Cloud Connector for CData Sync

Portfolio

Indicates a file within the Portfolio of a Marketing Cloud account.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Portfolio WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM Portfolio WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM Portfolio WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: DisplayName, FileName, CustomerKey, and Source_URN.

INSERT INTO Portfolio (DisplayName, FileName, CustomerKey,  Source_URN) VALUES ('portdisplayname', 'portfilename.jpg', 'portcuskey', 'https://example.com/image.jpg')

Update

You must specify the ObjectID in the WHERE clause when executing an update against this table.

UPDATE Portfolio SET DisplayName = 'ChangedDisplayName' WHERE ObjectID = 'nzxcaslkjd-123'

Delete

You must specify the ObjectID in the WHERE clause when executing a delete against this table.

DELETE FROM Portfolio WHERE ObjectID = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
RowObjectID String False

Identifier for the row of an object.

ObjectID [KEY] String False

System-controlled, text string identifier for object.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Client_ID Int False

The Id of the client.

CategoryID Int False

Specifies the identifier of the folder containing the email.

FileName String False

Indicates name of file associated with the object.

DisplayName String False

Name to be displayed for an item within a Portfolio.

Description String False

Describes and provides information regarding the object.

TypeDescription String False

Describes type for a Portfolio object.

IsUploaded Bool False

Indicates whether the Portfolio object in question was uploaded.

IsActive Bool False

Specifies whether or not the object is active.

FileSizeKB Int False

Specifies file size of a Portfolio item.

ThumbSizeKB Int False

Indicates size of a thumbnail image associated with a Portfolio object.

FileWidthPX Int False

Specifies the width of a Portfolio image in pixels.

FileHeightPX Int False

Specifies height of image contained in Portfolio (value)

FileURL String False

Specifies the URL at which a Portfolio file is stored.

ThumbURL String False

Indicates URL of a thumbnail image associated with a Portfolio object.

CacheClearTime Datetime False

Reserved for future use.

CategoryType String False

Defines whether a folder within a Portfolio is shared to other account users or not. Valid values are shared_portfolio, media.

CreatedDate Datetime False

Indicated the date and time of the object's creation.

CreatedBy Int False

The Id of the user who created the Portfolio.

ModifiedBy Int False

The id of the user who modified the Portfolio.

ModifiedDate Datetime False

Indicates the last time object information was modified.

ModifiedByName String True

The name of the user who modified the Portfolio.

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
Source_URN String

A URN (uniform resource name) of the location of the source.

Salesforce Marketing Cloud Connector for CData Sync

ProgramManifestTemplate

Reserved for future use. This table does not support deletes or inserts.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ProgramManifestTemplate WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM ProgramManifestTemplate WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-123')

SELECT * FROM ProgramManifestTemplate WHERE CreatedDate > '2017/01/25'

Update

You must specify the ObjectID in the WHERE clause when executing an update against this table.

UPDATE ProgramManifestTemplate SET Content = 'ChangedContent' WHERE ObjectID = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
ObjectID [KEY] String False

System-controlled, read-only text string identifier for object.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Client_ID Long False

The Id of the client.

Name String False

Name of the object or property.

Description String False

Describes and provides information regarding the object.

Type String False

Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master. Indicates the type of email to send to the address. Valid values include Text and HTML.

OperationType String False

Specifies metadata about the type of operation to perform.

Content String False

Identifies content contained in a content area.

IsActive Bool False

Specifies whether or not the object is active.

CreatedDate Datetime False

Read-only date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Salesforce Marketing Cloud Connector for CData Sync

QueryDefinition

Represents a SQL query activity accessed and performed by the SOAP API. This table does not support updates or inserts.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM QueryDefinition WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM QueryDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 456)

SELECT * FROM QueryDefinition WHERE CreatedDate > '2017/01/25'

Delete

You must specify the ObjectID in the WHERE clause when executing a delete against this table.

DELETE FROM QueryDefinition WHERE ObjectID = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
ObjectID [KEY] String False

System-controlled, text string identifier for object.

Client_ID Int False

The Id of the client.

Name String False

Name of the object or property.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Description String False

Describes and provides information regarding the object.

QueryText String False

Specifies text associated with a query definition.

TargetType String False

Indicates target type for a query definition.

DataExtensionTarget_Name String False

Name of the object or property.

DataExtensionTarget_CustomerKey String False

User-supplied unique identifier for an object within an object type

DataExtensionTarget_Description String False

Describes and provides information regarding the object.

TargetUpdateType String False

Indicates the target update type for a query definition.

FileType String False

Specifies column delimiter of a file (CSV, TAB, or Other).

FileSpec String False

Defines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%).

Status String False

Defines status of object.

CreatedDate Datetime False

Indicated the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

CategoryID Int False

Specifies the identifier of the folder containing the email.

Salesforce Marketing Cloud Connector for CData Sync

ReplyMailManagementConfiguration

Details configuration settings for the reply mail management in an account. This table does not support deletes.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ReplyMailManagementConfiguration WHERE Id = 123

SELECT * FROM ReplyMailManagementConfiguration WHERE Id IN (123, 456)

SELECT * FROM ReplyMailManagementConfiguration WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: EmailDisplayName and EmailReplyAddress.

INSERT INTO ReplyMailManagementConfiguration (EmailDisplayName, EmailReplyAddress) VALUES ('Test', '[email protected]')

Update

You must set a new value for EmailReplyAddress when executing an update against this table, and also supply its Id.

UPDATE ReplyMailManagementConfiguration SET EmailReplyAddress = '[email protected]' WHERE Id = 123

Columns

Name Type ReadOnly Description
ID [KEY] Int False

Identifier for an object.

Client_ID Int True

The Id of the client.

EmailDisplayName String False

Specifies the From name associated with the From email address as part of reply mail management configuration.

ReplySubdomain String False

Specifies subdomain associated with a reply mail management subdomain.

EmailReplyAddress String False

Specifies forwarding address for inbound emails resulting from a send.

CreatedDate Datetime False

Indicates the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

DNSRedirectComplete Bool False

Specifies whether a reply domain's DNS has been redirected to the Marketing Cloud IP addresses.

DeleteAutoReplies Bool False

Specifies whether auto-replies to a send should be deleted instead of forwarded to the RMM-configured email address.

SupportUnsubscribes Bool False

Indicates whether a reply mail management configuration allows subscribers to unsubscribe.

SupportUnsubKeyword Bool False

Indicates whether a reply mail management configuration supports a unsubscribe keyword.

SupportUnsubscribeKeyword Bool False

Indicates whether a reply mail management configuration supports a unsubscribe keyword.

SupportRemoveKeyword Bool False

Indicates whether a reply mail management configuration supports a remove keyword.

SupportOptOutKeyword Bool False

Indicates whether a reply mail management configuration supports an opt-out keyword.

SupportLeaveKeyword Bool False

Indicates whether a reply mail management configuration supports a leave keyword.

SupportMisspelledKeywords Bool False

Indicates whether a reply mail management configuration supports misspelled keywords.

SendAutoReplies Bool False

Indicates whether automatic replies should be sent as part of a reply mail management configuration.

AutoReplySubject String False

Contains the subject of the email message sent as an automatic reply.

AutoReplyBody String False

Contains the content of the message sent as an automatic reply.

ForwardingAddress String False

Specifies forwarding address for inbound emails resulting from a send.

ConversationLifetimeDays Int False

The number of lifetime days for a conversation.

ConversationLifetimeCycles Int False

The number of lifetime cycles for a conversation.

AnonymousRuleSet_ObjectID String True

System-controlled, read-only text string identifier for object.

AnonymousRuleSet_Name Int True

Name of the object or property.

AnonymousRuleSet_CustomerKey String True

User-supplied unique identifier for an object within an object type.

AnonymousAckTriggeredSend_ObjectID String True

System-controlled, read-only text string identifier for object.

AnonymousAckTriggeredSend_CustomerKey String True

User-supplied unique identifier for an object within an object type.

AnonymousAckTriggeredSend_Name String True

Name of the object or property.

AnonymousAckTriggeredSend_TriggeredSendStatus String True

Represents status of triggered send.

AnonymousForwardTriggeredSend_ObjectID String True

System-controlled, read-only text string identifier for object.

AnonymousForwardTriggeredSend_CustomerKey String True

User-supplied unique identifier for an object within an object type.

AnonymousForwardTriggeredSend_Name String True

Name of the object or property.

AnonymousForwardTriggeredSend_TriggeredSendStatus String True

Represents status of triggered send.

ResponderConversationRuleSet_ObjectID String True

System-controlled, read-only text string identifier for object.

ResponderConversationRuleSet_Name Int True

Name of the object or property.

ResponderConversationRuleSet_CustomerKey String True

User-supplied unique identifier for an object within an object type.

ResponderConversationAckTriggeredSend_ObjectID String True

System-controlled, read-only text string identifier for object.

ResponderConversationAckTriggeredSend_CustomerKey String True

User-supplied unique identifier for an object within an object type.

ResponderConversationAckTriggeredSend_Name String True

Name of the object or property.

ResponderConversationAckTriggeredSend_TriggeredSendStatus String True

Represents status of triggered send.

ResponderConversationForwardTriggeredSend_ObjectID String True

System-controlled, read-only text string identifier for object.

ResponderConversationForwardTriggeredSend_CustomerKey String True

User-supplied unique identifier for an object within an object type.

ResponderConversationForwardTriggeredSend_Name String True

Name of the object or property.

ResponderConversationForwardTriggeredSend_TriggeredSendStatus String True

Represents status of triggered send.

InitiatorConversationRuleSet_ObjectID String True

System-controlled, read-only text string identifier for object.

InitiatorConversationRuleSet_Name Int True

Name of the object or property.

InitiatorConversationRuleSet_CustomerKey String True

User-supplied unique identifier for an object within an object type.

InitiatorConversationAckTriggeredSend_ObjectID String True

System-controlled, read-only text string identifier for object.

InitiatorConversationAckTriggeredSend_CustomerKey String True

User-supplied unique identifier for an object within an object type.

InitiatorConversationAckTriggeredSend_Name String True

Name of the object or property.

InitiatorConversationAckTriggeredSend_TriggeredSendStatus String True

Represents status of triggered send.

InitiatorConversationForwardTriggeredSend_ObjectID String True

System-controlled, read-only text string identifier for object.

InitiatorConversationForwardTriggeredSend_CustomerKey String True

User-supplied unique identifier for an object within an object type.

InitiatorConversationForwardTriggeredSend_Name String True

Name of the object or property.

InitiatorConversationForwardTriggeredSend_TriggeredSendStatus String True

Represents status of triggered send.

ConversationExpirationTriggeredSend_ObjectID String True

System-controlled, read-only text string identifier for object.

ConversationExpirationTriggeredSend_CustomerKey String True

User-supplied unique identifier for an object within an object type.

ConversationExpirationTriggeredSend_Name String True

Name of the object or property.

ConversationExpirationTriggeredSend_TriggeredSendStatus String True

Represents status of triggered send.

MultiUseViolationTriggeredSend_ObjectID String True

System-controlled, read-only text string identifier for object.

MultiUseViolationTriggeredSend_CustomerKey String True

User-supplied unique identifier for an object within an object type.

MultiUseViolationTriggeredSend_Name String True

Name of the object or property.

MultiUseViolationTriggeredSend_TriggeredSendStatus String True

Represents status of triggered send.

InboundAddressIsOneUse Bool False

Specified whether the inbound address is one use.

Salesforce Marketing Cloud Connector for CData Sync

Send

Used to send email and retrieve aggregate data. This table does not support deletes or updates.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Send WHERE Id = 123

SELECT * FROM Send WHERE Id IN (123, 456)

SELECT * FROM Send WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: FromName, Email_Id, and List_Id.

INSERT INTO Send (FromName, Email_Id, List_Id) VALUES ('NASA', 31677, 52362)

Columns

Name Type ReadOnly Description
ID [KEY] Int False

Identifier for an object.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

CreatedDate Datetime False

Indicates the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Client_ID Int False

The Id of the client.

Client_PartnerClientKey String False

User-defined partner key for an account.

Email_ID Int False

Identifier for an object.

Email_PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

SendDate Datetime False

Indicates the date on which a send occurred.

FromAddress String False

Indicates From address associated with a object.

FromName String False

Specifies the default email message From Name.

Duplicates Int False

Represent the number of duplicate email addresses associated with a send.

InvalidAddresses Int False

Specifies the number of invalid addresses associated with a send.

ExistingUndeliverables Int False

Indicates whether bounces occurred on previous send.

ExistingUnsubscribes Int False

Indicates whether unsubscriptions occurred on previous send.

HardBounces Int False

Indicates number of hard bounces associated with a send.

SoftBounces Int False

Indicates number of soft bounces associated with a specific send.

OtherBounces Int False

Specifies number of Other-type bounces in a send.

ForwardedEmails Int False

Number of emails forwarded for a send.

UniqueClicks Int False

Indicates number of unique clicks on message.

UniqueOpens Int False

Indicates number of unique opens resulting from a triggered send.

NumberSent Int False

Number of emails actually sent as part of an email send.

NumberDelivered Int False

Number of sent emails that did not bounce.

NumberTargeted Int False

Indicates the number of possible recipients for an email send.

NumberErrored Int False

Number of emails not sent as part of a send because an error occurred while trying to build the email.

NumberExcluded Int False

Indicates the number recipients excluded froman email send because of a held, unsubscribed, master unsubscribed, or global unsubscribed status.

Unsubscribes Int False

Indicates the number of unsubscribe events associated with a send.

MissingAddresses Int False

Specifies number of missing addresses encountered within a send.

Subject String False

Defines the status of an object.

PreviewURL String False

Indicates URL used to preview the message associated with a send.

SentDate Datetime False

Indicates date on which a send took place.

EmailName String False

Specifies the name of an email message associated with a send.

Status String False

The status of the object.

IsMultipart Bool False

Indicates whether the email is sent with Multipart/MIME enabled.

SendLimit Int False

Indicates limit of messages to send as part of a send definition within a predefined send window.

SendWindowOpen Datetime False

Defines the beginning of a send window for a send definition.

SendWindowClose Datetime False

Defines the end of a send window for a send definition.

IsAlwaysOn Bool False

Indicates whether the request can be performed while the system is is maintenance mode.

Additional String False

The ID for a send that customers use as a campaign ID.

BCCEmail String False

Indicates email addresses to receive blind carbon copy of a message.

EmailSendDefinition_ObjectID String False

System-controlled, text string identifier for object.

EmailSendDefinition_CustomerKey String False

The customer key of the email send definition.

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
List_Id Int

The Id of the list to be sent.

Salesforce Marketing Cloud Connector for CData Sync

SendClassification

Represents a send classification in a Marketing Cloud account.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SendClassification WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM SendClassification WHERE ObjectID IN ('nzxcaslkjd-123', 456)

SELECT * FROM SendClassification WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name, DeliveryProfile_ObjectID, and SenderProfile_ObjectID.

INSERT INTO SendClassification (Name, DeliveryProfile_ObjectID, SenderProfile_ObjectID) VALUES ('TestName', 'aa1231231', 'vvb1231231')

Delete

You must specify the ObjectID in the WHERE clause when executing a delete against this table.

DELETE FROM SendClassification WHERE ObjectID = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
ObjectID [KEY] String False

System-controlled, text string identifier for object.

SendClassificationType String False

Defines the type for the applicable send classification. Valid values include Operational and Marketing.

Name String False

Name of the object or property.

Description String False

Describes and provides information regarding the object.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

SenderProfile_CustomerKey String False

The customer key of the sender profile.

SenderProfile_ObjectID String False

System-controlled, text string identifier for object.

DeliveryProfile_CustomerKey String False

The customer key of the delivery profile.

DeliveryProfile_ObjectID String False

System-controlled, text string identifier for object.

ArchiveEmail Bool False

Property definition.

Client_ID Long False

The Id of the client.

Client_PartnerClientKey String False

User-defined partner key for an account.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

CreatedDate Datetime False

Indicats the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Salesforce Marketing Cloud Connector for CData Sync

SenderProfile

The send profile used in conjunction with an email send definition.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SenderProfile WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM SenderProfile WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM SenderProfile WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name, FromName, and FromAddress.

INSERT INTO SenderProfile (Name, FromName, FromAddress) VALUES ('Test', 'Friendly Neighborhood', '[email protected]')

Update

You must specify the ObjectID in the WHERE clause when executing an update against this table.

UPDATE SenderProfile SET Name = 'changed_name', Description = 'changed_desc', FromName = 'changed_from_name', FromAddress = '[email protected]' WHERE ObjectID = 'nzxcaslkjd-123'

Delete

You must specify the ObjectID in the WHERE clause when executing a delete against this table.

DELETE FROM SenderProfile WHERE ObjectID = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
Name String False

Name of the object or property.

Description String False

Describes and provides information regarding the object.

FromName String False

Specifies the default email message From Name.

FromAddress String False

Indicates From address associated with a object.

UseDefaultRMMRules Bool False

Indicates whether a sender profile uses the default RMM rules for that account.

AutoForwardToEmailAddress String True

Indicates the email address to use with automatically forwarded email messages.

AutoForwardToName String True

Indicates the To name to use on automatically forwarded email messages.

DirectForward Bool False

Indicates whether the direct forward feature has been enabled for a sender profile.

AutoForwardTriggeredSend_ObjectID String False

System-controlled, text string identifier for object.

AutoReply Bool False

Indicates the reply associated with an automatically forwarded email message.

AutoReplyTriggeredSend_ObjectID String False

System-controlled, text string identifier for object.

SenderHeaderEmailAddress String False

Specifies the email address to include in the sender header of a sender profile.

SenderHeaderName String False

Specifies name to include in the sender header of a sender profile.

DataRetentionPeriodLength String False

Specifies the number of time units for which data will be retained.

ReplyManagementRuleSet_ObjectID String False

System-controlled, text string identifier for object.

RMMRuleCollection_ObjectID String False

System-controlled, text string identifier for object.

Client_ID Long False

The Id of the client.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

CreatedDate Datetime False

Indicates the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

ObjectID String False

System-controlled, text string identifier for object.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Client_CreatedBy Int False

Returns user ID for user who created object

Client_ModifiedBy Int False

Returns user ID for user who modified object.

Salesforce Marketing Cloud Connector for CData Sync

SMSTriggeredSend

Indicates a single instance of an SMS triggered send. This table does not support deletes or updates.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SMSTriggeredSend WHERE ObjectID = 123

SELECT * FROM SMSTriggeredSend WHERE ObjectID IN (123, 456)

SELECT * FROM SMSTriggeredSend WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following field when inserting to this table: SMSTriggeredSendDefinition_ObjectID.

INSERT INTO SMSTriggeredSend (SMSTriggeredSendDefinition_ObjectID) VALUES (123)

Columns

Name Type ReadOnly Description
ObjectID [KEY] String False

System-controlled, text string identifier for object.

CreatedDate Datetime False

Indicates the date and time of the object's creation.

Client_ID Int False

The Id of the client.

SmsSendId String False

Indicates ID for a specific SMS send.

SMSTriggeredSendDefinition_ObjectID String False

System-controlled, text string identifier for object.

Salesforce Marketing Cloud Connector for CData Sync

Subscriber

A person subscribed to receive email or SMS communication.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Subscriber WHERE Id = 123

SELECT * FROM Subscriber WHERE Id IN (123, 456)

SELECT * FROM Subscriber WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: SubscriberKey and EmailAddress.

INSERT INTO Subscriber (SubscriberKey, EmailAddress) VALUES (123, '[email protected]')

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Subscriber SET EmailAddress = '[email protected]' WHERE Id = 123

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Subscriber WHERE Id = 123

Columns

Name Type ReadOnly Description
ID Int False

Identifier for an object.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

CreatedDate Datetime False

Indicates the date and time of the object's creation.

Client_ID Int False

The Id of the client.

Client_PartnerClientKey String False

User-defined partner key for an account.

EmailAddress String False

Contains the email address for a subscriber.

SubscriberKey String False

Identification of a specific subscriber.

UnsubscribedDate Datetime False

Represents date subscriber unsubscribed from a list.

Status String False

Defines status of object.

EmailTypePreference String False

The format in which email should be sent.

Salesforce Marketing Cloud Connector for CData Sync

SuppressionListDefinition

A suppression list that can be associated with different contexts.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SuppressionListDefinition WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM SuppressionListDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM SuppressionListDefinition WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name.

INSERT INTO SuppressionListDefinition (Name) VALUES ('Test')

Update

You must specify the ObjectID in the WHERE clause when executing an update against this table.

UPDATE SuppressionListDefinition SET Name = 'Changed' WHERE ObjectID = 'nzxcaslkjd-123'

Delete

You must specify the ObjectID in the WHERE clause when executing a delete against this table.

DELETE FROM SuppressionListDefinition WHERE ObjectID = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
ObjectID String False

System-controlled, text string identifier for object.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Name String False

Name of the object or property.

Description String False

Describes and provides information regarding the object.

Client_CreatedBy Int False

Returns user ID for user who created object

CreatedDate Datetime False

Indicates the date and time of the object's creation.

Client_ModifiedBy Int False

Returns user ID for user who modified object.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Category Long False

ID of the folder that an item is located in.

Client_ID Int False

The Id of the client.

Client_EnterpriseID Long False

The EnterpriseID of the client.

SubscriberCount Long False

Indicates the number of records on a suppression list.

Salesforce Marketing Cloud Connector for CData Sync

TriggeredSendDefinition

To create or update a TriggeredSendDefinition where the list ID is the All Subs List ID, you need the Email | Subscribers | All Subscribers | View and SendEmailToList permissions.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM TriggeredSendDefinition WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM TriggeredSendDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM TriggeredSendDefinition WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name, SendClassification_ObjectID, and Email_Id.

INSERT INTO TriggeredSendDefinition (Name, SendClassification_ObjectID, Email_Id) VALUES ('Test', 'nzxcaslkjd-789', 123)

Update

You must specify the ObjectID in the WHERE clause when executing an update against this table.

UPDATE TriggeredSendDefinition SET Description = 'Changed' WHERE ObjectID = 'nzxcaslkjd-123'

Delete

You must specify the ObjectID in the WHERE clause when executing a delete against this table.

When deleting a row from this table, the row will not be deleted, but instead the value of TriggeredSendStatus will be set to false.

DELETE FROM TriggeredSendDefinition WHERE ObjectID = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
ObjectID [KEY] String False

System-controlled, text string identifier for object.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

CreatedDate Datetime False

Indicates the date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Client_ID Long False

The Id of the client.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Email_ID Int False

Identifier for an object.

List_ID Int False

Identifier for an object.

Name String False

Name of the object or property.

Description String False

Describes and provides information regarding the object.

TriggeredSendType String False

Deprecated.

TriggeredSendStatus String False

Represents status of triggered send.

HeaderContentArea_ID Int False

Identifier for an object.

FooterContentArea_ID Int False

Identifier for an object.

SendClassification_ObjectID String False

System-controlled, text string identifier for object.

SendClassification_CustomerKey String False

The customer key of the send classification.

SenderProfile_CustomerKey String False

The customer key of the sender profile.

SenderProfile_ObjectID String False

System-controlled, text string identifier for object.

DeliveryProfile_CustomerKey String False

The customer key of the delivery profile.

DeliveryProfile_ObjectID String False

System-controlled, text string identifier for object.

PrivateDomain_ObjectID String False

System-controlled, text string identifier for object.

PrivateIP_ID Int True

Read-only identifier for an object.

AutoAddSubscribers Bool False

Indicates whether a triggered send recipient should be added to a subscriber list.

AutoUpdateSubscribers Bool False

Indicates if any subscriber information should be updated as part of a triggered send.

BatchInterval Int False

Deprecated.

FromName String False

Specifies the default email message From Name.

FromAddress String False

Indicates From address associated with a object.

BccEmail String False

Indicates email addresses to receive blind carbon copy of a message.

EmailSubject String False

Subject for an email send.

DynamicEmailSubject String False

Contains content to be used in a dynamic subject line.

IsMultipart Bool False

Indicates whether the email is sent with Multipart/MIME enabled.

IsWrapped Bool False

Indicates whether an email send contains the links necessary to process tracking information for clicks.

TestEmailAddr String False

Specified a test email address.

AllowedSlots String False

Reserved for future use.

NewSlotTrigger Int False

Deprecated.

SendLimit Int False

Indicates limit of messages to send as part of a send definition within a predefined send window.

SendWindowOpen Datetime False

Defines the beginning of a send window for a send definition.

SendWindowClose Datetime False

Defines the end of a send window for a send definition.

SuppressTracking Bool False

Indicates whether the send definition suppresses tracking results for associated sends.

Keyword String False

Reserved for future use.

List_PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

Email_PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

SendClassification_PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

PrivateDomain_PartnerKey String True

Unique identifier provided by partner for an object, accessible only via API.

PrivateIP_PartnerKey String True

Unique identifier provided by partner for an object, accessible only via API.

Client_PartnerClientKey String False

User-defined partner key for an account.

IsPlatformObject Bool False

Indicated whether the object is a platform object.

CategoryID Int False

Specifies the identifier of the folder containing the email.

Salesforce Marketing Cloud Connector for CData Sync

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Salesforce Marketing Cloud Connector for CData Sync Views

Name Description
Automation Defines an automation that exists within Automation Studio for an account.
BounceEvent Contains SMTP and other information pertaining to the specific event of an email message bounce.
ClickEvent Contains time and date information, as well as a URL ID and a URL, regarding a click on a link contained in a message.
DataExtensionField Represents a field within a data extension.
DataExtensionTemplate Represents a data extension template within an account.
DataFolder Represents a folder in a Marketing Cloud account
DoubleOptInMOKeyword The DoubleOptInMOKeyword object defines an MO keyword, allowing a mobile user to subscribe to SMS messages using a double opt-in workflow.
FileTriggerTypeLastPull Reserved for future use.
ForwardedEmailEvent Indicates a subscriber used the Forward To A Friend feature to send an email to another person.
ForwardedEmailOptInEvent Specifies an opt-in event related to a Forward To A Friend event.
HelpMOKeyword Defines actions associated with the HELP SMS keyword for an account.
ImportResultsSummary A retrieve-only object that contains status and aggregate information on an individual import started from an ImportDefinition.
LinkSend Provides information about a link in a send.
ListSend Specifies retrieve-only properties associated with the list(s) for a completed send.
ListSubscriber Retrieves subscribers for a list or lists for a subscriber.
MessagingVendorKind Contains the vendor details for an SMS (short message service) or voice messaging vendor. Deprecated.
NotSentEvent Contains information on when email message failed to be sent.
OpenEvent Contains information about the opening of a message send by a subscriber.
PrivateIP The PrivateIP object contains information on private IP address to be used as part of messages sends.
Publication Reserved for future use.
PublicationSubscriber Describes subscriber on a publication list.
PublicKeyManagement Reserved for future use.
ResultItem Contains results of asynchronous API call.
ResultMessage Message containing results of async call.
Role Defines roles and permissions assigned to a user in an account.
SendEmailMOKeyword Defines the action that sends a triggered email message to the email addresses defined in an MO message.
SendSMSMOKeyword Defines actions to take when the specified MO keyword is received.
SendSummary A retrieve only object that contains summary information about a specific send event.
SentEvent Contains tracking data related to a send, including information on individual subscribers.
SMSMTEvent Contains information on a specific SMS message sent to a subscriber.
SMSSharedKeyword Contains information used to request a keyword for use with SMS messages in a Marketing Cloud account.
SMSTriggeredSendDefinition Defines the send definition for an SMS message.
SubscriberList Use to retrieve lists for a specific subscriber.
SubscriberSendResult Reserved for future use.
SubscriberStatusEvent null
SuppressionListContext Defines a context that a SuppressionListDefinition can be associated with.
SurveyEvent Contains information on when a survey response took place.
Template Represents an email template in a Marketing Cloud account.
TimeZone Represents a specific time zone in the application.
TriggeredSendSummary Summary of results for a specific triggered send.
UnsubEvent Contains information regarding a specific unsubscription action taken by a subscriber.
UnsubscribeFromSMSPublicationMOKeyword Defines keyword used by a subscriber to unsubscribe from an SMS publication list.

Salesforce Marketing Cloud Connector for CData Sync

Automation

Defines an automation that exists within Automation Studio for an account.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but DateTime values: =, !=, <>, >, >=, <, <=, IN. For DateTime values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Automation WHERE ObjectID = 123

SELECT * FROM Automation WHERE ObjectID IN (123, 456)

SELECT * FROM Automation WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
Name String Name of the object or property.
Description String Describes and provides information regarding the object.
Schedule_ID Int Read-only identifier for the schedule.
CustomerKey String User-supplied unique identifier for an object within an object type.
Client_ID Long The Id of the client.
IsActive Bool Specifies whether or not the object is active.
CreatedDate Datetime Read-only date and time of the object's creation.
Client_CreatedBy Int Returns user ID for user who created object.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ModifiedBy Int Returns user ID for user who modified object..
Status Int Indicates status of automation.
Client_EnterpriseID Long Reserved for future use.

Salesforce Marketing Cloud Connector for CData Sync

BounceEvent

Contains SMTP and other information pertaining to the specific event of an email message bounce.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM BounceEvent WHERE Id = 123

SELECT * FROM BounceEvent WHERE Id IN (123, 456)

SELECT * FROM BounceEvent WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
ObjectID String System-controlled, read-only text string identifier for object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API..
CreatedDate Datetime Read-only date and time of the object's creation..
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Int Specifies Id of the client.
SendID Int Contains identifier for a specific send.
SubscriberKey String Identification of a specific subscriber.
EventDate Datetime Date when a tracking event occurred.
SMTPCode String Contains SMTP code related to a bounced email.
BounceCategory String Defines category for bounce associated with a bounced email.
SMTPReason String Contains SMTP reason associated with a bounced email.
BounceType String Defines type of bounce associated with a bounced email.
EventType String The type of tracking event.
TriggeredSendDefinitionObjectID String Identifies the triggered send definition associated with an event.
BatchID Int Ties triggered send sent events to other events.

Salesforce Marketing Cloud Connector for CData Sync

ClickEvent

Contains time and date information, as well as a URL ID and a URL, regarding a click on a link contained in a message.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ClickEvent WHERE Id = 123

SELECT * FROM ClickEvent WHERE Id IN (123, 456)

SELECT * FROM ClickEvent WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
ObjectID String System-controlled, read-only text string identifier for object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Int The Id of the client.
SendID Int Contains identifier for a specific send.
SubscriberKey String Identification of a specific subscriber.
EventDate Datetime Date when a tracking event occurred.
EventType String The type of tracking event
TriggeredSendDefinitionObjectID String Identifies the triggered send definition associated with an event.
BatchID Int Ties triggered send sent events to other events.
URLID Int Indicates URL ID associated with a click tracking event.
URL String Indicates URL included in an event or configuration.

Salesforce Marketing Cloud Connector for CData Sync

DataExtensionField

Represents a field within a data extension.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataExtensionField WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CustomerKey String User-supplied unique identifier for an object within an object type, which corresponds to the external key assigned to an object in the user interface.
Name String Name of the object or property.
DefaultValue String The default value for a data extension field if no value is supplied.
MaxLength Int Maximum length of the data.
IsRequired Bool Indicates whether the property must have a value specified.
Ordinal Int Indicates position of object within an array
IsPrimaryKey Bool Designates whether a data extension field is used as a primary key for that data extension.
FieldType String Designates data type for a data extension field.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Scale Int Indicates numeric precision for decimal properties.
Client_ID Int The Id of the client.
DataExtension_CustomerKey String User-supplied unique identifier for an object within an object type.
StorageType String Indicates special storage properties for the field. Valid values are: Unspecified, Plain, Encrypted, or Obfuscated.

Salesforce Marketing Cloud Connector for CData Sync

DataExtensionTemplate

Represents a data extension template within an account.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataExtensionTemplate WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CustomerKey String User-supplied unique identifier for an object within an object type.
Name String Name of the object or property.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Int The Id of the client.
Description String Describes and provides information regarding the object.
IsSendable Bool Specifies whether the template is sendable.
IsTestable Bool Specifies whether the template is testable.
SendableCustomObjectField String Specifies a sendable custom object field.
SendableSubscriberField String Specifies a sendable subscriber field.
DataRetentionPeriodLength String Specifies until when should the data be retained.
DataRetentionPeriodUnitOfMeasure Int Specifies the unit of measure for the data rentention period.
RowBasedRetention Bool Specifies whether row based retention is enabled.
ResetRetentionPeriodOnImport Bool Specifies whether retention period should be reset on import.
DeleteAtEndOfRetentionPeriod Bool Specifies whether the data should be deleted at the end of the retention period.
RetainUntil Datetime Specified until when the data should be retained.

Salesforce Marketing Cloud Connector for CData Sync

DataFolder

Represents a folder in a Marketing Cloud account

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataFolder WHERE Id = 123

SELECT * FROM DataFolder WHERE Id IN (123, 456)

SELECT * FROM DataFolder WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
Client_ID Int The Id of the client.
ParentFolder_ID Int Specifies the parent folder If for a data folder.
ParentFolder_CustomerKey String User-supplied unique identifier for an object within an object type.
ParentFolder_ObjectID String System-controlled, read-only text string identifier for object.
ParentFolder_Name String Name of the object or property.
ParentFolder_Description String Describes and provides information regarding the object.
ParentFolder_ContentType String Defines the type of content contained within a folder.
ParentFolder_IsActive Bool Specifies whether or not the object is active.
ParentFolder_IsEditable Bool Indicates if the property can be edited by the end-user in the profile center.
ParentFolder_AllowChildren Bool Specifies whether a data folder can have child data folders.
Name String Name of the object or property.
Description String Describes and provides information regarding the object.
ContentType String Defines the type of content contained within a folder.
IsActive Bool Specifies whether or not the object is active.
IsEditable Bool Indicates if the property can be edited by the end-user in the profile center.
AllowChildren Bool Specifies whether a data folder can have child data folders.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ModifiedBy Int Returns user ID for user who modified object.
ObjectID String System-controlled, read-only text string identifier for object.
CustomerKey String User-supplied unique identifier for an object within an object type.
Client_EnterpriseID Long Reserved for future use.
Client_CreatedBy Int Returns user ID for user who created object

Salesforce Marketing Cloud Connector for CData Sync

DoubleOptInMOKeyword

The DoubleOptInMOKeyword object defines an MO keyword, allowing a mobile user to subscribe to SMS messages using a double opt-in workflow.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM DoubleOptInMOKeyword WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
Client_ID Int The Id of the client.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
CustomerKey String User-supplied unique identifier for an object within an object type.
IsDefaultKeyword Bool Specifies if account defaults to this SMS keyword action if no other options are available.
DefaultPublication_ID Int Read-only identifier for an object.
InvalidPublicationMessage String Specifies message to send in case a subscriber requests subscription to or unsubscription from an invalid publication list.
InvalidResponseMessage String Specifies message to send in case a subscriber sends in an invalid response.
MissingPublicationMessage String Reserved for future use.
NeedPublicationMessage String Specifies message to send in case a subscriber sends in an response that does not specify a publication list.
PromptMessage String Contains message sent to subscriber to prompt response as part of the double opt-in process.
SuccessMessage String Defines SMS message to send if triggered email send succeeds.
UnexpectedErrorMessage String Contains message to send to subscriber in case of unexpected error.
ValidPublications String Defines valid publication lists for use with a double opt-in event.
ValidResponses String Defines valid responses a subscriber can use as part of a double opt-in process.

Salesforce Marketing Cloud Connector for CData Sync

FileTriggerTypeLastPull

Reserved for future use.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM FileTriggerTypeLastPull WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM FileTriggerTypeLastPull WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

Columns

Name Type Description
Client_ID Long The Id of the client.
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
ExternalReference String Reserved for future use.
Type String Indicates type of specific list.
LastPullDate Datetime Reserved for future use.

Salesforce Marketing Cloud Connector for CData Sync

ForwardedEmailEvent

Indicates a subscriber used the Forward To A Friend feature to send an email to another person.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ForwardedEmailEvent WHERE Id = 123

SELECT * FROM ForwardedEmailEvent WHERE Id IN (123, 456)

SELECT * FROM ForwardedEmailEvent WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
ObjectID String System-controlled, read-only text string identifier for object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Int The Id of the client.
SendID Int Contains identifier for a specific send.
SubscriberKey String Identification of a specific subscriber.
EventDate Datetime Date when a tracking event occurred.
EventType String The type of tracking event.
TriggeredSendDefinitionObjectID String Identifies the triggered send definition associated with an event.
BatchID Int Ties triggered send sent events to other events.

Salesforce Marketing Cloud Connector for CData Sync

ForwardedEmailOptInEvent

Specifies an opt-in event related to a Forward To A Friend event.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ForwardedEmailOptInEvent WHERE Id = 123

SELECT * FROM ForwardedEmailOptInEvent WHERE Id IN (123, 456)

SELECT * FROM ForwardedEmailOptInEvent WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
ObjectID String System-controlled, read-only text string identifier for object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Int The Id of the client.
SendID Int Contains identifier for a specific send.
SubscriberKey String Identification of a specific subscriber.
EventDate Datetime Date when a tracking event occurred.
EventType String The type of tracking event.
TriggeredSendDefinitionObjectID String Identifies the triggered send definition associated with an event.
BatchID Int Ties triggered send sent events to other events.
OptInSubscriberKey String Specifies the subscriber key of a subscriber opted in via forwarded email.

Salesforce Marketing Cloud Connector for CData Sync

HelpMOKeyword

Defines actions associated with the HELP SMS keyword for an account.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM HelpMOKeyword WHERE Client_ID = 123

SELECT * FROM HelpMOKeyword WHERE Client_ID IN (123, 456)

SELECT * FROM HelpMOKeyword WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
Client_ID Int The Id of the client.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
CustomerKey String User-supplied unique identifier for an object within an object type.
IsDefaultKeyword Bool Specifies if account defaults to this SMS keyword action if no other options are available.
MoreChoicesPrompt String Text used to inform MO message sender of more available choices as part of a HELP keyword action.
DefaultHelpMessage String Contains default message to deliver for a HELP MO message.
MenuText String Defines text to use for outlining multiple response options in the response to a HELP MO request.
FriendlyName String Contains the friendly name for a HELP MO keyword.

Salesforce Marketing Cloud Connector for CData Sync

ImportResultsSummary

A retrieve-only object that contains status and aggregate information on an individual import started from an ImportDefinition.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ImportResultsSummary WHERE Id = 123

SELECT * FROM ImportResultsSummary WHERE Id IN (123, 456)

SELECT * FROM ImportResultsSummary WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
ID Int Read-only identifier for an object.
Client_ID Long The Id of the client.
ImportDefinitionCustomerKey String Specifies customer key associated with import definition used in an import.
TaskResultID Int Indicates the task result ID associated with a summary of import results.
ImportStatus String Specifies import status associated with an import.
StartDate String Indicates the start date for the time period for which to retrieve import results.
EndDate String Specifies the end data of an activity.
DestinationID String Specifies the identifier of either the list or the data extension associated with a completed import.
NumberSuccessful Int Specifies number of successful record imports resulting from an import action.
NumberDuplicated Int Specifies number of duplicated records resulting from an import.
NumberErrors Int Indicates number of errors resulting from an import.
TotalRows Int Indicates the total number of rows included in the summary of an import.
ImportType String Specfies type of import performed.

Salesforce Marketing Cloud Connector for CData Sync

LinkSend

Provides information about a link in a send.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM LinkSend WHERE Id = 123

SELECT * FROM LinkSend WHERE Id IN (123, 456)

SELECT * FROM LinkSend WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
SendID Int Contains identifier for a specific send.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
Client_ID Int The Id of the client.
Client_PartnerClientKey String User-defined partner key for an account.
Link_ID Int The Id of the link.
Link_PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
Link_TotalClicks Int Indicates total number of clicks on link in message.
Link_UniqueClicks Int Indicates number of unique clicks on message.
Link_URL String Indicates URL included in an event or configuration.
Link_Alias String Name of link contained in message.

Salesforce Marketing Cloud Connector for CData Sync

ListSend

Specifies retrieve-only properties associated with the list(s) for a completed send.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ListSend WHERE Id = 123

SELECT * FROM ListSend WHERE Id IN (123, 456)

SELECT * FROM ListSend WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
Client_ID Int The Id of the client.
SendID Int Contains identifier for a specific send.
List_ID Int Read-only identifier for an object.
List_ListName String The name of the list.
Duplicates Int Represent the number of duplicate email addresses associated with a send (exists only when a send occurs to multiple lists).
InvalidAddresses Int Specifies the number of invalid addresses associated with a send.
ExistingUndeliverables Int Indicates whether bounces occurred on previous send.
ExistingUnsubscribes Int Indicates whether unsubscriptions occurred on previous send.
HardBounces Int Indicates number of hard bounces associated with a send.
SoftBounces Int Indicates number of soft bounces associated with a specific send.
OtherBounces Int Specifies number of Other-type bounces in a send.
ForwardedEmails Int Number of emails forwarded for a send.
UniqueClicks Int Indicates number of unique clicks on message.
UniqueOpens Int Indicates number of unique opens resulting from a triggered send.
NumberSent Int Number of emails actually sent as part of an email send. This number reflects all of the sent messages and may include bounced messages.
NumberDelivered Int Number of sent emails that did not bounce.
Unsubscribes Int Indicates the number of unsubscribe events associated with a send.
MissingAddresses Int Specifies number of missing addresses encountered within a send.
PreviewURL String Indicates URL used to preview the message associated with a send.

Salesforce Marketing Cloud Connector for CData Sync

ListSubscriber

Retrieves subscribers for a list or lists for a subscriber.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ListSubscriber WHERE Id = 123

SELECT * FROM ListSubscriber WHERE Id IN (123, 456)

SELECT * FROM ListSubscriber WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
ObjectID String System-controlled, read-only text string identifier for object.
SubscriberKey String Identification of a specific subscriber.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Int The Id of the client.
Client_PartnerClientKey String User-defined partner key for an account.
ListID Int Defines identification for a list the subscriber resides on.
Status String Defines status of an object.
UnsubscribedDate Datetime The date the subscriber unsubscribed.

Salesforce Marketing Cloud Connector for CData Sync

MessagingVendorKind

Contains the vendor details for an SMS (short message service) or voice messaging vendor. Deprecated.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM MessagingVendorKind WHERE Id = 123

SELECT * FROM MessagingVendorKind WHERE Id IN (123, 456)

SELECT * FROM MessagingVendorKind WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Identifier for an object.
Vendor String Deprecated.
Kind String Deprecated.
IsUsernameRequired Bool Deprecated.
IsPasswordRequired Bool Deprecated.
IsProfileRequired Bool Deprecated.
CreatedDate Datetime Indicates the date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.

Salesforce Marketing Cloud Connector for CData Sync

NotSentEvent

Contains information on when email message failed to be sent.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM NotSentEvent WHERE SendID = 123

SELECT * FROM NotSentEvent WHERE SendID IN (123, 456)

SELECT * FROM NotSentEvent WHERE CreatedDate > '2024/01/25'

Columns

Name Type Description
SendID Int Contains identifier for a specific send.
SubscriberKey String Identification of a specific subscriber.
EventDate Datetime Date when a tracking event occurred.
Client_ID Int The Id of the client.
EventType String The type of tracking event
BatchID Int Ties triggered send sent events to other events.
TriggeredSendDefinitionObjectID String Identifies the triggered send definition associated with an event.
ListID Int Defines identification for a list the subscriber resides on.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
SubscriberID Int The Id of the subscriber.

Salesforce Marketing Cloud Connector for CData Sync

OpenEvent

Contains information about the opening of a message send by a subscriber.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM OpenEvent WHERE Id = 123

SELECT * FROM OpenEvent WHERE Id IN (123, 456)

SELECT * FROM OpenEvent WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
ObjectID String System-controlled, read-only text string identifier for object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Int The Id of the client.
SendID Int Contains identifier for a specific send.
SubscriberKey String Identification of a specific subscriber.
EventDate Datetime Date when a tracking event occurred.
EventType String The type of tracking event
TriggeredSendDefinitionObjectID String Identifies the triggered send definition associated with an event.
BatchID Int Ties triggered send sent events to other events.

Salesforce Marketing Cloud Connector for CData Sync

PrivateIP

The PrivateIP object contains information on private IP address to be used as part of messages sends.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM PrivateIP WHERE Id = 123

SELECT * FROM PrivateIP WHERE Id IN (123, 456)

SELECT * FROM PrivateIP WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CreatedDate Datetime Read-only date and time of the object's creation.
Client_ID Int The Id of the client.
Name String Name of the object or property.
Description String Describes and provides information regarding the object.
IsActive Bool Specifies whether or not the object is active.
OrdinalID String Defines position of object within an array of information.
IPAddress String Contains IP address to be used in for a private IP.
Client_PartnerClientKey String User-defined partner key for an account.

Salesforce Marketing Cloud Connector for CData Sync

Publication

Reserved for future use.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Publication WHERE Id = 123

SELECT * FROM Publication WHERE Id IN (123, 456)

SELECT * FROM Publication WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Int The Id of the client.
Client_PartnerClientKey String User-defined partner key for an account.
Name String Name of the object or property.
Category Int ID of the folder that an item is located in.

Salesforce Marketing Cloud Connector for CData Sync

PublicationSubscriber

Describes subscriber on a publication list.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM PublicationSubscriber WHERE Publication_ID = 123

SELECT * FROM PublicationSubscriber WHERE Publication_ID IN (123, 456)

SELECT * FROM PublicationSubscriber WHERE Publication_CreatedDate > '2017/01/25'

Columns

Name Type Description
Publication_ID Int Read-only identifier for an object.
Publication_PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
Publication_CreatedDate Datetime Read-only date and time of the object's creation.
Publication_ModifiedDate Datetime Indicates the last time object information was modified.
Publication_Client_ID Int Read-only identifier for an object.
Publication_Client_PartnerClientKey String Unique identifier provided by partner for an object, accessible only via API.
Client_ID Int The Id of the client.
Client_PartnerClientKey String User-defined partner key for an account.
Publication_Name String Name of the object or property.
Publication_Category Int The category of the publication.
Subscriber_ID Int Read-only identifier for an object.
Subscriber_SubscriberKey String Identification of a specific subscriber.
Subscriber_PrimarySMSAddress_AddressType String The address type of the subscriber.
Subscriber_PrimarySMSAddress_Address String The address of the subscriber.
Subscriber_PrimarySMSAddress_Carrier String The carrier of the subscriber.
Subscriber_PrimarySMSPublicationStatus String The primary SMS publication status of the subscriber.

Salesforce Marketing Cloud Connector for CData Sync

PublicKeyManagement

Reserved for future use.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM PublicKeyManagement WHERE Id = 123

SELECT * FROM PublicKeyManagement WHERE Id IN (123, 456)

SELECT * FROM PublicKeyManagement WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
Client_ID Long The Id of the client.
Name String Name of the object or property.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
Key String Specifies key associated with content area in HTML body.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.

Salesforce Marketing Cloud Connector for CData Sync

ResultItem

Contains results of asynchronous API call.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ResultItem WHERE AsyncAPIRequestQueueID = 123

SELECT * FROM ResultItem WHERE AsyncAPIRequestQueueID IN (123, 456)

SELECT * FROM ResultItem WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
AsyncAPIRequestQueueID Int The Id of the async API request queue.
RequestID String Unique ID of initial async API call.
ConversationID String Unique ID of initial async API call. All requests that should be processed as a single unit will have the same ConversationID.
CorrelationID String Identifies correlation of objects across several requests.
Client_ID Int The Id of the client.
CreatedDate Datetime Read-only date and time of the object's creation.
StatusCode String Status of async API request.
StatusMessage String Describes the status of an API call.
OrdinalID Int System-controlled, read-only text string identifier for object.
ErrorCode Int Identifies the error of an API request via a numeric code.
RequestType String Defines request as synchronous or asynchronous API.
RequestObjectType String Defines type of the Request object, such as email or triggered send.
ResultType Int Defines result as coming from synchronous or asynchronous API.
Client_PartnerClientKey String User-defined partner key for an account.

Salesforce Marketing Cloud Connector for CData Sync

ResultMessage

Message containing results of async call.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ResultMessage WHERE RequestID = 123

SELECT * FROM ResultMessage WHERE RequestID IN (123, 456)

SELECT * FROM ResultMessage WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
RequestID String Unique ID of initial async API call.
ConversationID String Unique ID of initial async API call.
Client_ID Int The Id of the client.
CreatedDate Datetime Read-only date and time of the object's creation.
OverallStatusCode String Represents overall status of conversation via async API.
StatusCode String Status of async API request.
StatusMessage String Describes the status of an API call.
ErrorCode Int Identifies the error of an API request.
RequestType String Defines request as synchronous or asynchronous API.
ResultType String Defines result as coming from synchronous or asynchronous API.
ResultDetailXML String Contains details of operation result in XML format.
Client_PartnerClientKey String User-defined partner key for an account.

Salesforce Marketing Cloud Connector for CData Sync

Role

Defines roles and permissions assigned to a user in an account.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Account WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM Account WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM Account WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
CustomerKey String User-supplied unique identifier for an object within an object type.
Name String Name of the object or property.
Description String Describes and provides information regarding the object.
IsPrivate Bool Indicates whether role is defined by Marketing Cloud or a client.
IsSystemDefined Bool Indicates whether role is defined by the application.
Client_EnterpriseID Long Reserved for future use.
Client_ID Int The Id of the client.
Client_CreatedBy Int Returns user ID for user who created object
CreatedDate Datetime Read-only date and time of the object's creation.
Client_ModifiedBy Int Returns user ID for user who modified object.
ModifiedDate Datetime Indicates the last time object information was modified.
PermissionSets String Indicates permission sets applied to a Role or PermissionSet object.
Permissions String Specifies an array of permissions.

Salesforce Marketing Cloud Connector for CData Sync

SendEmailMOKeyword

Defines the action that sends a triggered email message to the email addresses defined in an MO message.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SendEmailMOKeyword WHERE Client_ID = 123

SELECT * FROM SendEmailMOKeyword WHERE Client_ID IN (123, 456)

SELECT * FROM SendEmailMOKeyword WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
Client_ID Int The Id of the client.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
CustomerKey String User-supplied unique identifier for an object within an object type.
NextState_CustomerKey String The customer key of the next state.
IsDefaultKeyword Bool Specifies if account defaults to this SMS keyword action if no other options are available.
SuccessMessage String Defines SMS message to send if triggered email send succeeds.
MissingEmailMessage String Defines message to send if MO message does not contain a valid email address.
FailureMessage String Defines message to deliver in case the email send fails.
TriggeredSend_CustomerKey String The customer key of the triggered send definition.

Salesforce Marketing Cloud Connector for CData Sync

SendSMSMOKeyword

Defines actions to take when the specified MO keyword is received.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SendSMSMOKeyword WHERE Client_ID = 123

SELECT * FROM SendSMSMOKeyword WHERE Client_ID IN (123, 456)

SELECT * FROM SendSMSMOKeyword WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
Client_ID Int The Id of the client.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
NextMOKeyword_CustomerKey String Defines the customer key of the next MO keyword to use in an SMS conversation.
CustomerKey String User-supplied unique identifier for an object within an object type.
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
IsDefaultKeyword Bool Specifies if account defaults to this SMS keyword action if no other options are available.
Message String Contains contents of results message.
ScriptErrorMessage String Defines message to deliver to subscriber in case of an error in the SMS conversation.

Salesforce Marketing Cloud Connector for CData Sync

SendSummary

A retrieve only object that contains summary information about a specific send event.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SendSummary WHERE Client_ID = 123

SELECT * FROM SendSummary WHERE Client_ID IN (123, 456)

SELECT * FROM SendSummary WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
Client_ID Int The Id of the client.
AccountID Int Identifier for account.
SendID Int Contains identifier for a specific send.
DeliveredTime String Indicates the time a message was delivered.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
CustomerKey String User-supplied unique identifier for an object within an object type.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
AccountName String Name of account.
AccountEmail String Specifies email address attached to account.
IsTestAccount Bool Specifies whether or not an account is a 'Test' account.
TotalSent Int Indicates total number of messages sent as part of a send.
Transactional Int Indicates number of transactional messages included in a send.
NonTransactional Int Specifies number of marketing (non-transactional) messages included as part of a send.

Salesforce Marketing Cloud Connector for CData Sync

SentEvent

Contains tracking data related to a send, including information on individual subscribers.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SentEvent WHERE Client_ID = 123

SELECT * FROM SentEvent WHERE Client_ID IN (123, 456)

SELECT * FROM SentEvent WHERE EventDate > '2024/01/25'

Columns

Name Type Description
SendID Int Contains identifier for a specific send.
SubscriberKey String Identification of a specific subscriber.
EventDate Datetime Date when a tracking event occurred.
Client_ID Int The Id of the client.
EventType String The type of tracking event
BatchID Int Ties triggered send sent events to other events.
TriggeredSendDefinitionObjectID String Identifies the triggered send definition associated with an event.
ListID Int Defines identification for a list the subscriber resides on.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
SubscriberID Int The Id of the subscriber.

Salesforce Marketing Cloud Connector for CData Sync

SMSMTEvent

Contains information on a specific SMS message sent to a subscriber.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SMSMTEvent WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM SMSMTEvent WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM SMSMTEvent WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
EventDate Datetime Date when a tracking event occurred.
Client_ID Long The Id of the client.
MOCode String Specifies the MO code associated with a specific MO or MT tracking event.
SMSTriggeredSend_SMSSendId String Indicates ID for a specific SMS send.
SMSTriggeredSend_SMSTriggeredSendDefinition_ObjectID String System-controlled, read-only text string identifier for object.
SMSTriggeredSend_SMSTriggeredSendDefinition_CustomerKey String User-supplied unique identifier for an object within an object type.
Subscriber_ID Int Read-only identifier for an object.
Subscriber_SubscriberKey String Identification of a specific subscriber.
Subscriber_PrimarySMSAddress_Address String The primary SMS address of the subscribers.
Carrier String Name of the SMS carrier associated with an SMS address.

Salesforce Marketing Cloud Connector for CData Sync

SMSSharedKeyword

Contains information used to request a keyword for use with SMS messages in a Marketing Cloud account.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SMSSharedKeyword WHERE Client_ID = 123

SELECT * FROM SMSSharedKeyword WHERE Client_ID IN (123, 456)

SELECT * FROM SMSSharedKeyword WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Long The Id of the client.
SharedKeyword String Specifies keyword requested for use in an account.
RequestDate Datetime Specifies the date when the request for an SMS shared keyword was made.
EffectiveDate Datetime Specifies when an SMS shared keyword becomes active for use.
ExpireDate Datetime Specifies when an SMS shared keyword stops being active for use.
ReturnToPoolDate Datetime Specifies the date when an expired SMS keyword can be requested for different use in a short code.
ShortCode String Specifies the short code for which an SMS keyword was requested.

Salesforce Marketing Cloud Connector for CData Sync

SMSTriggeredSendDefinition

Defines the send definition for an SMS message.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SMSTriggeredSendDefinition WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM SMSTriggeredSendDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM SMSTriggeredSendDefinition WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
CustomerKey String User-supplied unique identifier for an object within an object type.
Client_ID Long The Id of the client.
Name String Name of the object or property.
Description String Describes and provides information regarding the object.
Publication_ID Int Read-only identifier for an object.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Content_ID Int Read-only identifier for an object.
SendToList Bool Indicates whether SMS triggered send goes to a list or a single subscriber.
DataExtension_ObjectID String System-controlled, read-only text string identifier for object.
IsPlatformObject Bool Indicated whether the object is a platform object.

Salesforce Marketing Cloud Connector for CData Sync

SubscriberList

Use to retrieve lists for a specific subscriber.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SubscriberList WHERE Id = 123

SELECT * FROM SubscriberList WHERE Id IN (123, 456)

SELECT * FROM SubscriberList WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ListSubID Long Identifier for an object.
ID [KEY] Int Identifier for an object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CreatedDate Datetime date and time of the object's creation.
Subscriber_UnsubscribedDate Datetime The unsubscribed date of the subscriber.
Client_ID Int The Id of the client.
Status String Defines status of object.
List_ID Int Identifier for an object.
List_ListName String The name of the list.
Subscriber_Status String Defines status of object.
Subscriber_CreatedDate Datetime Indicates the date and time of the object's creation.
Subscriber_ID Int identifier for an object.
Subscriber_EmailAddress String The email address of a subscriber.
Subscriber_SubscriberKey String Identification of a specific subscriber.
Subscriber_PartnerKey String Unique identifier provided by partner for an object, accessible only via API.

Salesforce Marketing Cloud Connector for CData Sync

SubscriberSendResult

Reserved for future use.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SubscriberSendResult WHERE Id = 123

SELECT * FROM SubscriberSendResult WHERE Id IN (123, 456)

SELECT * FROM SubscriberSendResult WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
Send_ID Int Read-only identifier for an object.
ID [KEY] Int Read-only identifier for an object.
Email_ID Int Read-only identifier for an object.
Email_Name String Name of the object or property.
Subject String Contains subject area information for a message.
FromName String Specifies the default email message From Name.
FromAddress String Indicates From address associated with a object.
SentDate Datetime Indicates date on which a send took place.
OpenDate Datetime Specifies data on which a subscriber opened a send.
ClickDate Datetime Specifies the data subscriber clicked a link included in a send.
Subscriber_Partnerkey String Unique identifier provided by partner for an object, accessible only via API.
Subscriber_EmailAddress String The email address of the subscriber.
Subscriber_PartnerType String The partner type of the subscriber.
UnsubscribeDate Datetime Indicates the date on which an unsubscribe event took place due to a send.
LastOpenDate Int Specifies the date subscribe was last opened.
LastClickDate Int Specifies the date subscribe was last clicked.
BounceDate Datetime Contains the date on which an individual send bounced for a subscriber.
EventDate Int Indicated the date of the event.
TotalClicks Int Indicates total number of clicks on link in message.
UniqueClicks Int Indicates number of unique clicks on message.
EmailAddress Int Indicates From address associated with a object.
Subscriber_ID Int Read-only identifier for an object.
SubscriberTypeID Int Read-only identifier for an object.
Subscriber_SubscriberKey String The subscriber key of the subscriber.
Send_PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
Client_ID Int The Id of the client.
OtherBounces Int Specifies number of Other-type bounces in a send.
SoftBounces Int Indicates number of soft bounces associated with a specific send.
HardBounces Int Indicates number of hard bounces associated with a send.

Salesforce Marketing Cloud Connector for CData Sync

SubscriberStatusEvent

null

Columns

Name Type Description
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
SubscriberID Long The Id of the subscriber.
Client_ID Long The Id of the client.
CurrentStatus String Defines current status of object.
PreviousStatus String Defines previous status of object.
CreatedDate Datetime Indicates the date and time of the object's creation.
SubscriberKey String Identification of a specific subscriber.
ReasonUnsub String Represents the reason why the subscriber unsubscribed from a list.

Salesforce Marketing Cloud Connector for CData Sync

SuppressionListContext

Defines a context that a SuppressionListDefinition can be associated with.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SuppressionListContext WHERE Id = 123

SELECT * FROM SuppressionListContext WHERE Id IN (123, 456)

SELECT * FROM SuppressionListContext WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
Definition_ObjectID String System-controlled, read-only text string identifier for object.
Definition_Name String Name of the object or property.
Definition_CustomerKey String User-supplied unique identifier for an object within an object type.
Definition_Category Long The category of the defition.
Definition_Description String Describes and provides information regarding the object.
Context String The context with which a SuppressionListDefinition is associated.
SendClassification_ObjectID String System-controlled, read-only text string identifier for object.
Send_ID Int Read-only identifier for an object.
SenderProfile_ObjectID String System-controlled, read-only text string identifier for object.
SendClassificationType String Defines the type for the applicable send classification. Valid values include Operational and Marketing.
Client_CreatedBy Int Returns user ID for user who created object
CreatedDate Datetime Read-only date and time of the object's creation.
Client_ModifiedBy Int Returns user ID for user who modified object.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Long The Id of the client.
Client_EnterpriseID Long Reserved for future use.
AppliesToAllSends Bool Indicates whether this context applies to all transactional and marketing sends.

Salesforce Marketing Cloud Connector for CData Sync

SurveyEvent

Contains information on when a survey response took place.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM SurveyEvent WHERE Id = 123

SELECT * FROM SurveyEvent WHERE Id IN (123, 456)

SELECT * FROM SurveyEvent WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
ObjectID String System-controlled, read-only text string identifier for object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Int The Id of the client.
SendID Int Contains identifier for a specific send.
SubscriberKey String Identification of a specific subscriber.
EventDate Datetime Date when a tracking event occurred.
EventType String The type of tracking event.
TriggeredSendDefinitionObjectID String Identifies the triggered send definition associated with an event.
BatchID Int Ties triggered send sent events to other events.
Question String Specifies question associated with a survey event.
Answer String The answer provided by a subscriber to the survey question.

Salesforce Marketing Cloud Connector for CData Sync

Template

Represents an email template in a Marketing Cloud account.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Template WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM Template WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM Template WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ObjectID String System-controlled, read-only text string identifier for object.
ID [KEY] Int Read-only identifier for an object.
Client_ID Int The Id of the client.
TemplateName String Name used to identify template within Marketing Cloud application.
LayoutHTML String Contains HTML used to define layout of fields and content within template.
BackgroundColor String Specifies background color used for template.
BorderColor String Specifies border color used in template.
BorderWidth Int Specifies border pixel width used in template.
Cellpadding Int Specifies pixel width of padding within cells used in template.
Cellspacing Int Specifies pixel spacing between cells used in template.
Width Int Specifies the pixel width of the entire template
Align String Indicates the alignment of elements within the template.
ActiveFlag Int Indicates whether the template is available for use within the account.
CategoryID Int Indicates whether content validation has completed for this email message.
CategoryType String Identifies correlation of objects across several requests.
OwnerID Int Specifies MID of business unit that created the template within an Enterprise 2.0 account.
HeaderContent_ID Int The Id of the header content.
HeaderContent_ObjectID String System-controlled, read-only text string identifier for object.
Layout_ID Int The Id of the layout.
Layout_LayoutName String The name of the layout.
CustomerKey String User-supplied unique identifier for an object within an object type.
TemplateSubject String Contains email subject line specified by the template.
IsTemplateSubjectLocked Bool Indicates whether the subject defined in the header can be changed or not by email using template.

Salesforce Marketing Cloud Connector for CData Sync

TimeZone

Represents a specific time zone in the application.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM TimeZone

Columns

Name Type Description
ID [KEY] Int Read-only identifier for an object.
Name String Name of the object or property.

Salesforce Marketing Cloud Connector for CData Sync

TriggeredSendSummary

Summary of results for a specific triggered send.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM TriggeredSendSummary WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM TriggeredSendSummary WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM TriggeredSendSummary WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ObjectID [KEY] String System-controlled, read-only text string identifier for object.
Client_ID Long The Id of the client.
Client_PartnerClientKey String User-defined partner key for an account.
CustomerKey String User-supplied unique identifier for an object within an object type.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
Sent Long Indicates number of messages sent.
NotSentDueToOptOut Long Indicates number of sends not completed due to a subscriber's decision to opt out of receiving messages.
NotSentDueToUndeliverable Long Indicates number of sends not completed due to a subscriber's undeliverable status.
Bounces Long Indicates number of bounces resulting from a triggered send.
Opens Long Indicates number of opens from a triggered send.
UniqueOpens Long Indicates number of opens from a triggered send.
Clicks Long Indicates the number of clicks resulting from a triggered send.
UniqueClicks Long Indicates number of unique clicks on message.
OptOuts Long Indicates number of subscribers who opted out of receiving messages after receiving a triggered send.
SurveyResponses Long Indicates number of responses to a survey question contained in a triggered send.
FTAFRequests Long Indicates number of Forward To A Friend requests received as part of a triggered send.
FTAFEmailsSent Long Indicates Forward To A Friend emails sent as a result of a triggered send.
FTAFOptIns Long Indicates number of subscribers opting in to receiving messages as a result of a Forward To A Friend action from a triggered send.
Conversions Long Indicates the number of conversions results from a triggered send.
UniqueConversions Long Indicates number of unique conversions resulting from a triggered send.
InProcess Long Indicates the number of triggered send messages in progress. Deprecated.
NotSentDueToError Long Indicates number of triggered send messages not sent due to error.
RowObjectID String The row id of the object.
TriggeredSendDefinition_ObjectID String The Id of the associated triggered send definition for triggered send.
Queued Long Indicates number of messages queued for sending.

Salesforce Marketing Cloud Connector for CData Sync

UnsubEvent

Contains information regarding a specific unsubscription action taken by a subscriber.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM UnsubEvent WHERE Id = 123

SELECT * FROM UnsubEvent WHERE Id IN (123, 456)

SELECT * FROM UnsubEvent WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
ID Int Read-only identifier for an object.
ObjectID String System-controlled, read-only text string identifier for object.
PartnerKey String Unique identifier provided by partner for an object, accessible only via API.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
Client_ID Int The Id of the client.
SendID Int Contains identifier for a specific send.
SubscriberKey String Identification of a specific subscriber.
EventDate Datetime Date when a tracking event occurred.
EventType String The type of tracking event
TriggeredSendDefinitionObjectID String Identifies the triggered send definition associated with an event.
BatchID Int Ties triggered send sent events to other events.
List_ID Int Indicates the id of the list involved in the unsubscription.
List_Type String Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master.
List_ListClassification String Specifies the classification for a list.
IsMasterUnsubscribed Bool Indicates whether the subscriber master unsubscribed.

Salesforce Marketing Cloud Connector for CData Sync

UnsubscribeFromSMSPublicationMOKeyword

Defines keyword used by a subscriber to unsubscribe from an SMS publication list.

View-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE Client_ID = 123

SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE Client_ID IN (123, 456)

SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE CreatedDate > '2017/01/25'

Columns

Name Type Description
Client_ID Int The Id of the client.
CreatedDate Datetime Read-only date and time of the object's creation.
ModifiedDate Datetime Indicates the last time object information was modified.
CustomerKey String User-supplied unique identifier for an object within an object type.
NextMOKeyword_CustomerKey String Defines next MO keyword to use in an SMS conversation.
IsDefaultKeyword Bool Specifies if account defaults to this SMS keyword action if no other options are available.
AllUnsubSuccessMessage String Contains message to send to subscriber when they have successfully unsubscribed from all SMS publication lists.
InvalidPublicationMessage String Specifies message to send in case a subscriber requests subscription to or unsubscription from an invalid publication list.
SingleUnsubSuccessMessage String Contains message to send to subscriber when they have successfully unsubscribed from a single publication list.

Salesforce Marketing Cloud Connector for CData Sync

Connection String Options

The connection string 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 string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to Salesforce Marketing Cloud.
UseLegacyAuthenticationA boolean determining if the connection should be made to Salesforce Marketing Cloud REST API using the legacy authentication.
UserSpecifies the user ID of the authenticating Salesforce Marketing Cloud user account.
PasswordSpecifies the password of the authenticating user account.
SubdomainThe subdomain of the Salesforce Marketing Cloud API.
UseAsyncBatchWhether to use the synchronous or the asynchronous SOAP API to perform Batch insert.
WaitForBulkResultsWhether to wait for bulk results when using the asynchronous API. Only active when UseAsyncBatch is true.

OAuth


PropertyDescription
OAuthClientIdSpecifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecretSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
ScopeSpace-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.

SSL


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
SchemaSpecify the Salesforce Marketing Cloud server version to connect with.

Miscellaneous


PropertyDescription
AccountIdThe account identifier, or MID, of the target business unit.
DisplayChildDataExtensionsDisplays the Data Extensions of Child Accounts if set.
Instance[DEPRECATED] The instance of the Salesforce Marketing Cloud API used.
ListDataExtensionsA boolean determining if data extensions should be listed as tables or not.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PagesizeSpecifies the maximum number of results to return from Salesforce Marketing Cloud, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
QueryAllAccountsQueries all accounts, including parent and all children, regarding an event.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
TimeZoneThe server timezone. The format should use the UTC offset, for example: +00:00.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Salesforce Marketing Cloud Connector for CData Sync

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to Salesforce Marketing Cloud.
UseLegacyAuthenticationA boolean determining if the connection should be made to Salesforce Marketing Cloud REST API using the legacy authentication.
UserSpecifies the user ID of the authenticating Salesforce Marketing Cloud user account.
PasswordSpecifies the password of the authenticating user account.
SubdomainThe subdomain of the Salesforce Marketing Cloud API.
UseAsyncBatchWhether to use the synchronous or the asynchronous SOAP API to perform Batch insert.
WaitForBulkResultsWhether to wait for bulk results when using the asynchronous API. Only active when UseAsyncBatch is true.
Salesforce Marketing Cloud Connector for CData Sync

AuthScheme

The type of authentication to use when connecting to Salesforce Marketing Cloud.

Remarks

Select among the following connection properties:

  • OAuth: Specifies user-account OAuth authentication.
  • OAuthClient: Specifies Server-to-Server OAuth authentication.
  • Basic: Specifies BASIC user/password authentication.

Salesforce Marketing Cloud Connector for CData Sync

UseLegacyAuthentication

A boolean determining if the connection should be made to Salesforce Marketing Cloud REST API using the legacy authentication.

Remarks

The default value for ths property is false.

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

Salesforce Marketing Cloud Connector for CData Sync

User

Specifies the user ID of the authenticating Salesforce Marketing Cloud user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Salesforce Marketing Cloud Connector for CData Sync

Password

Specifies the password of the authenticating user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Salesforce Marketing Cloud Connector for CData Sync

Subdomain

The subdomain of the Salesforce Marketing Cloud API.

Remarks

The subdomain can be obtained as follows:

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

Salesforce Marketing Cloud Connector for CData Sync

UseAsyncBatch

Whether to use the synchronous or the asynchronous SOAP API to perform Batch insert.

Remarks

This property determines whether or not the asynchronous API is used for Insert data to Salesforce Marketing Cloud. These requests will be processed asynchronously meaning the driver will not wait for Salesforce to process the results fully. You can query the following table to get information about the jobs and batches that were created:

SELECT * FROM LastResultInfo#TEMP

Salesforce Marketing Cloud Connector for CData Sync

WaitForBulkResults

Whether to wait for bulk results when using the asynchronous API. Only active when UseAsyncBatch is true.

Remarks

This property determines whether the Sync App will wait for bulk requests to report their status. By default this property is false and any INSERT queries will complete as soon as they are submitted to Salesforce Marketing Cloud. When this property is true, the Sync App will wait for INSERT to finish.

When this property is false, data modification queries will be faster but less detailed status information will be available. The LastResultInfo#TEMP table will list the creates batches and not the status of individual rows. Information about individual rows will only be availble if you execute the GetBatchResults stored procedure for each batch.

When this property is true, data modification queries will be slower but more status information will be available. The LastResultInfo#TEMP table will list the ID of each updated row, its status and any associated error messages.

Salesforce Marketing Cloud Connector for CData Sync

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
OAuthClientIdSpecifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecretSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
ScopeSpace-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.
Salesforce Marketing Cloud Connector for CData Sync

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Salesforce Marketing Cloud Connector for CData Sync

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Salesforce Marketing Cloud Connector for CData Sync

Scope

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.

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.

Salesforce Marketing Cloud Connector for CData Sync

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Salesforce Marketing Cloud Connector for CData Sync

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

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.

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

Salesforce Marketing Cloud Connector for CData Sync

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
Salesforce Marketing Cloud Connector for CData Sync

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol Default Port Description
TUNNEL 80 The port where the Sync App opens a connection to Salesforce Marketing Cloud. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the Sync App opens a connection to Salesforce Marketing Cloud. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5 1080 The port where the Sync App sends data to Salesforce Marketing Cloud. If the SOCKS 5 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.

Salesforce Marketing Cloud Connector for CData Sync

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Salesforce Marketing Cloud Connector for CData Sync

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Salesforce Marketing Cloud Connector for CData Sync

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Salesforce Marketing Cloud Connector for CData Sync

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Salesforce Marketing Cloud Connector for CData Sync

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
Salesforce Marketing Cloud Connector for CData Sync

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

Salesforce Marketing Cloud Connector for CData Sync

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Salesforce Marketing Cloud Connector for CData Sync

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Salesforce Marketing Cloud Connector for CData Sync

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

  • BASIC: The Sync App performs HTTP BASIC authentication.
  • DIGEST: The Sync App performs HTTP DIGEST authentication.
  • NTLM: The Sync App retrieves an NTLM token.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

Salesforce Marketing Cloud Connector for CData Sync

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyUser
BASIC The user name of a user registered with the proxy server.
DIGEST The user name of a user registered with the proxy server.
NEGOTIATE The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

Salesforce Marketing Cloud Connector for CData Sync

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyPassword
BASIC The password associated with the proxy server user specified in ProxyUser.
DIGEST The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE The password associated with the Windows user account specified in ProxyUser.
NTLM The password associated with the Windows user account specified in ProxyUser.
NONE Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

Salesforce Marketing Cloud Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTODefault setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Salesforce Marketing Cloud Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Salesforce Marketing Cloud Connector for CData Sync

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Salesforce Marketing Cloud Connector for CData Sync

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Salesforce Marketing Cloud Connector for CData Sync

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
SchemaSpecify the Salesforce Marketing Cloud server version to connect with.
Salesforce Marketing Cloud Connector for CData Sync

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

Note: Since this Sync App supports multiple schemas, custom schema files for Salesforce Marketing Cloud should be structured such that:

  • Each schema should have its own folder, named for that schema.
  • All schema folders should be contained in a parent folder.

Location should always be set to the parent folder, and not to an individual schema's folder.

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

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

Salesforce Marketing Cloud Connector for CData Sync

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Salesforce Marketing Cloud Connector for CData Sync

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Salesforce Marketing Cloud Connector for CData Sync

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Salesforce Marketing Cloud Connector for CData Sync

Schema

Specify the Salesforce Marketing Cloud server version to connect with.

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.

Salesforce Marketing Cloud Connector for CData Sync

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
AccountIdThe account identifier, or MID, of the target business unit.
DisplayChildDataExtensionsDisplays the Data Extensions of Child Accounts if set.
Instance[DEPRECATED] The instance of the Salesforce Marketing Cloud API used.
ListDataExtensionsA boolean determining if data extensions should be listed as tables or not.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PagesizeSpecifies the maximum number of results to return from Salesforce Marketing Cloud, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
QueryAllAccountsQueries all accounts, including parent and all children, regarding an event.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
TimeZoneThe server timezone. The format should use the UTC offset, for example: +00:00.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Salesforce Marketing Cloud Connector for CData Sync

AccountId

The account identifier, or MID, of the target business unit.

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.

Salesforce Marketing Cloud Connector for CData Sync

DisplayChildDataExtensions

Displays the Data Extensions of Child Accounts if set.

Remarks

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

Salesforce Marketing Cloud Connector for CData Sync

Instance

[DEPRECATED] The instance of the Salesforce Marketing Cloud API used.

Remarks

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

  1. Log in to Marketing Cloud.
  2. Click the name of your account.
  3. Copy the MID value for your account.
  4. In a separate browser tab or window, navigate to https://trust.marketingcloud.com.
  5. 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.

Salesforce Marketing Cloud Connector for CData Sync

ListDataExtensions

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

Remarks

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

Salesforce Marketing Cloud Connector for CData Sync

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Salesforce Marketing Cloud Connector for CData Sync

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

Salesforce Marketing Cloud Connector for CData Sync

Pagesize

Specifies the maximum number of results to return from Salesforce Marketing Cloud, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

Salesforce Marketing Cloud Connector for CData Sync

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Salesforce Marketing Cloud Connector for CData Sync

QueryAllAccounts

Queries all accounts, including parent and all children, regarding an event.

Remarks

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

Salesforce Marketing Cloud Connector for CData Sync

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Salesforce Marketing Cloud Connector for CData Sync

TimeZone

The server timezone. The format should use the UTC offset, for example: +00: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.

Salesforce Marketing Cloud Connector for CData Sync

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:


{
	"MyView": {
		"query": "SELECT * FROM Subscriber WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175