Skip to main content

Salesforce Marketing Cloud Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

The Salesforce Marketing Cloud Reader is designed to seamlessly integrate with Salesforce Marketing Cloud, enabling efficient data extraction from its platform. This adapter supports reading data from various objects, such as campaigns, journeys, and performance metrics, to facilitate analytics and reporting.

The Salesforce Marketing Cloud Reader allows users to configure incremental reads using a specified marker column, ensuring efficient data synchronization. By supporting critical properties like OAuth authentication and flexible table configurations, the adapter provides a reliable solution for integrating Salesforce Marketing Cloud data into broader analytics pipelines.

Feature summary

Feature

Supported?

Notes

Objects

Standard objects

✓

Custom objects

✓

Authentication

Basic authentication

Username and password

OAuth authentication

✓

Manual configuration based

Custom authentication methods

Not all methods may be supported

Operations

Automated mode

✓

Initial load

✓

Pull-based incremental load

✓

Push-based incremental load

Automated pipeline

Governance

Connection profile

Sherlock AI

Sentinel AI

Schema handling

Initial schema creation

✓

Works with supported targets

Schema evolution

Setup

Wizard template

Flow Designer

✓

Striim TQL

✓

Runtime

Resilience/recovery

✓

Parallel execution

Metrics

✓

Standard metrics

Supported authentication

The Salesforce Marketing Cloud Reader supports OAuth authentication. Creating a connection requires creating and registering an application, and obtaining the OAuth client credentials which consist of a client ID and client secret.

To create a custom OAuth application:

  1. Log in to your Salesforce Marketing Cloud and navigate to Marketing Cloud > Administration > Installed Packages.

  2. Choose New.

  3. Specify a package name and description.

  4. Save the package. The saved package contains important data; see Installed Packages Definitions for more information about each field. Note that you see the Package ID, JWT signing secret, and Source Account only for packages created in your account.

  5. Under Components, choose Add Component.

  6. Select API Integration.

  7. You must select Server-to-Server or Web App as the integration type if the package supports enhanced functionality.

  8. Assign the appropriate scope for your integration.

    1. Perform server-to-server requests... is automatically selected for all API Integrations.

    2. Select Perform requests on behalf of the user... if this package contains a Marketing Cloud application.

    3. Select the Marketing Cloud scope for your API calls. Assign only the scope your package needs.

  9. Save the component.

  10. Locate the Client ID and Client Secret under the component details.

Supported objects

The Salesforce Marketing Cloud models support 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. This section describes the list of objects supported by each API model

REST API models

The REST API exposes broader access to Salesforce Marketing Cloud capabilities. All new Salesforce Marketing Cloud technologies implement REST API. The following tables are supported in the REST API model:

  • Assets

  • Callbacks

  • Campaigns

  • Categories

  • EventDefinitions

  • FacebookMessengerProperties

  • JourneyActivities

  • Journeys

  • LineMessengerProperties

  • SendDefinitions

  • Subscriptions

SOAP API models

The SOAP API provides comprehensive access to most email functionality. The SOAP API uses SOAP envelopes to pass information between external apps and Salesforce Marketing Cloud. The following tables are supported in the SOAP API model:

  • Account

  • AccountUser

  • BusinessUnit

  • ContentArea

  • DataExtension

  • Email

  • EmailSendDefinition

  • FileTrigger

  • FilterDefinition

  • ImportDefinition

  • List

  • Portfolio

  • ProgramManifestTemplate

  • QueryDefinition

  • ReplyMailManagementConfiguration

  • Send

  • SendClassification

  • SenderProfile

  • SMSTriggeredSend

  • Subscriber

  • SuppressionListDefinition

  • TriggeredSendDefinition

Salesforce Marketing Cloud Reader properties

Property

Type

Default value

Notes

Auth mode

Select List (Enum)

OAuthClient

Currently supports only OAuthClient.

Client ID

String

Client ID of the custom app registered in Salesforce Marketing Cloud.

Client secret

Password

Client secret of the custom app registered in Salesforce Marketing Cloud.

Connection pool size

Integer

20

Specifies the maximum number of active connections.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Specify the name of the column that contains the start position value. This column must meet the following criteria:

  • It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID).

  • The values must be unique and continuously increasing to ensure proper incremental reading.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list (Enum):

  • Automated mode

  • Initial load

  • Incremental load

Automated

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

Integer

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The reader polls the source at the specified interval.

Refresh token

Password

An OAuth 2.0 refresh token.Use the value generated while creating the token.

Start Position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Subdomain

String

Subdomain of the app registered in Salesforce Marketing Cloud.

Tables

String

A semicolon-delimited (;) list of objects to read from the source. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.