Salesforce Marketing Cloud Batch Source

The Salesforce Marketing Cloud batch source plugin is available for Preview in the Hub.

Plugin version: 1.3.2

Reads from one or multiple objects within Salesforce Marketing Cloud depending on the mode values set for this plugin. For Multi Object mode, the source outputs a record for each row from the object it reads, with each record containing an additional field that holds the name of the object from which the record came from. For Single Object mode, this additional field will not be in the output. In addition, for each object that is read, this plugin sets pipeline arguments where the key is multisink.[objectname] and the value is the schema of the object.

Configuration

Property	Macro Enabled?	Description

Property	Macro Enabled?	Description
Reference Name	No	Required. Name used to uniquely identify this source for lineage, annotating metadata.
Data Retrieval Mode	Yes	Required. Mode of data retrieval. The mode can be one of two values: `Multi Object`. Fetches data for multiple data extensions, `Single Object`. Fetches data for single data extension. Default is `Single Object`.
Object	Yes	Optional. Specify the object for which data to be fetched. This can be one of following values: `Bounce Event`. Fetches Tracking Bounce Events. `Data Extension`. Fetches data for a single Data Extension object. `Email`. Fetches data for Email object. `Mailing List`. Fetches data for Mailing List object. `NotSent Event`. Fetches Tracking Not Sent Events. `Open Event`. Fetches Tracking Open Events. `Sent Event`. Fetches Tracking Sent Events. `Unsub Event`. Fetches Tracking UnSubscribe Events. Note: This value is ignored if Data Retrieval Mode is set to `Multi Object`. Default is `Data Extension`.
Object List	Yes	Optional. Specify the list of objects from which to fetch data. This can be one or more values from following possible values: `Bounce Event`. Fetches Tracking Bounce Events. `Data Extension`. Fetches data for a single Data Extension object. `Email`. Fetches data for Email object. `Mailing List`. Fetches data for Mailing List object. `NotSent Event`. Fetches Tracking Not Sent Events. `Open Event`. Fetches Tracking Open Events. `Sent Event`. Fetches Tracking Sent Events. `Unsub Event`. Fetches Tracking UnSubscribe Events. Note: This value is ignored if Data Retrieval Mode is set to `Single Object`.
Data Extension External Keys	Yes	Optional. Specify the data extension key from which to fetch data. Note, this value is ignored in following cases: If Data Retrieval Mode is set to `Multi Object`. If the selected Object name is other than `Data Extension`.
Table Name Field	Yes	Optional. The name of the field that holds the object name to which the data belongs to. Must not be the name of any column for any of the objects that will be read. For the `Data Extension` object, this field will have a value in `dataextension_[Data Extension Key]` format. Note, the Table Name property value is ignored if the is set to `Single Object`. Default is `tablename`.
Filter	Yes	Optional. The filter selection criteria. For example, `eventDate > '2010-01-01' and subscriberKey = 1001`
Client ID	Yes	Required. OAuth2 client ID associated with an installed package in Salesforce Marketing Cloud.
Client Secret	Yes	Required. TOAuth2 client secret associated with an installed package in Salesforce Marketing Cloud.
Authentication Base URI	Yes	Required. Authentication Base URL associated for the Server-to-Server API integration. For example, `https://instance.auth.marketingcloudapis.com/`
SOAP API Endpoint	Yes	Required. The SOAP Endpoint URL associated for the Server-to-Server API integration. For example, `https://instance.soap.marketingcloudapis.com/Service.asmx`
REST API Base URI	Yes	Required. The REST API Base URL associated for the Server-to-Server API integration. For example, `https://instance.rest.marketingcloudapis.com/`

Data Type Mappings from Salesforce Marketing Cloud to CDAP

The following table lists out different SFMC data types, as well as the corresponding CDAP types.

SFMC type	CDAP type

SFMC type	CDAP type
string	string
phone	string
email_address	string
local	string
integer/number	int
double/decimal	double
boolean	boolean
timestamp	timestamp