Salesforce CDP Connector 1.0 Reference - Mule 4
Anypoint Connector for Salesforce CDP (Salesforce CDP Connector) provides customers a pipeline to send data from both non-Salesforce and Salesforce properties alike into Salesforce CDP.
Configurations
SDC Config
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
Name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
Connection types for this configuration. |
x |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the response times out. |
1 |
|
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
MINUTES |
|
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
AUTO |
|
Name |
String |
ID used to reference this configuration. |
x |
|
Expiration Policy |
Configures an expiration policy for the configuration. |
Connection Types
OAuth JWT
Custom connection provider for the OAuth JWT flow.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header. |
Headers automatically added to every outbound request. |
||
Query Parameters |
Array of Default Query Param. |
Query parameters automatically added to every outbound request. |
||
Connection Timeout |
Number |
How long the connector waits before timing out when initially establishing a connection to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
Indicates whether to use persistent connections:
|
true |
|
Max Connections |
Number |
Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput. |
-1 |
|
Connection Idle Timeout |
Number |
When persistent connections are enabled, how long a connection can remain idle before Mule closes it. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Proxy Config |
Configures a proxy for outbound connections. |
|||
Stream Response |
Boolean |
If this value is |
false |
|
Response Buffer Size |
Number |
Size of the buffer that stores the HTTP response, in bytes. |
-1 |
|
Consumer key |
String |
Consumer key for the Salesforce-connected app. |
x |
|
Key store |
String |
Path to the keystore used to sign data during authentication. |
x |
|
Store password |
String |
Password of the keystore. |
x |
|
Certificate alias |
String |
Alias of the certificate. |
x |
|
Subject |
String |
Username of the desired Salesforce user to take action on behalf of. |
x |
|
Audience url |
String |
Identifies the authorization server as an intended audience. |
x |
|
Protocol |
Enumeration, one of:
|
Protocol to use for communication. Valid values are |
HTTP |
|
TLS Configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
OAuth Username Password
Custom connection provider for the username and password flow.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header. |
Headers automatically added to every outbound request. |
||
Query Parameters |
Array of Default Query Param. |
Query parameters automatically added to every outbound request. |
||
Connection Timeout |
Number |
How long the connector waits before timing out when initially establishing a connection to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
Indicates whether to use persistent connections:
|
true |
|
Max Connections |
Number |
Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput. |
-1 |
|
Connection Idle Timeout |
Number |
When persistent connections are enabled, how long a connection can remain idle before Mule closes it. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Proxy Config |
Configures a proxy for outbound connections. |
|||
Stream Response |
Boolean |
If this value is |
false |
|
Response Buffer Size |
Number |
Size of the buffer that stores the HTTP response, in bytes. |
-1 |
|
Consumer key |
String |
Consumer key for the Salesforce-connected app. |
x |
|
Consumer secret |
String |
Your application’s client secret (consumer secret in Remote Access Detail). |
x |
|
Username |
String |
Username used to initialize the session. |
x |
|
Password |
String |
Password used to authenticate the user. |
x |
|
Audience url |
String |
Identifies the authorization server as an intended audience. |
x |
|
Protocol |
Enumeration, one of:
|
Protocol to use for communication. Valid values are |
HTTP |
|
TLS Configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
Bulk - Create Job
<sdc:create-bulk-job>
Creates a job that represents the bulk operation for managing data. This operation makes an HTTP POST request to the /ingest/jobs endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Source API name |
String |
Name of the ingestion source API to work with. |
x |
|
Object name |
String |
Name of object to work with. |
x |
|
Operation |
Enumeration, one of:
|
Operation to execute. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the response times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Bulk - Upload Job Data
<sdc:upload-data-bulk-job>
Ingests external datasets into CDP. This operation makes an HTTP PUT request to the /ingest/jobs/{id}/batches endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
ID |
String |
Job ID returned in the response body from the Create Job request. |
x |
|
Body |
String |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the response times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Bulk - Close / Abort Job
<sdc:update-bulk-operation-job>
Updates the job for the specified job ID. This operation makes an HTTP PATCH request to the /api/v1/ingest/jobs/{id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
Identifier of the job. |
x |
|
State |
Enumeration, one of:
|
New state for the job. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the response times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Bulk - Delete Job
<sdc:delete-bulk-job>
Deletes the job for the specified job ID. This operation makes an HTTP DELETE request to the /ingest/jobs/{id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
Identifier of the job. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the response times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Bulk - Get Job
<sdc:get-bulk-job>
Retrieves the job details for the specified job ID. This operation makes an HTTP GET request to the /api/v1/ingest/jobs/{id} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Job ID |
String |
Identifier of the job. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the response times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Streaming - Insert Objects
<sdc:insert-objects>
Used to insert objects. This operation makes an HTTP POST request to the /ingest/connectors/{connector-name}/{object-name} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Source API name |
String |
Ingest source API name. |
x |
|
Object name |
String |
Name of the collection to load data into. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the response times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Streaming - Delete Objects
<sdc:delete-objects>
Used to delete objects. This operation makes an HTTP DELETE request to the /ingest/connectors/{connector-name}/{object-name} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Source API name |
String |
Ingest source API name. |
x |
|
Object name |
String |
Name of the collection to delete data from. |
x |
|
IDs |
Array of String |
Comma-separated list of IDs to delete. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the response times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Query
<sdc:query>
Used for queries. This operation makes an HTTP POST request to the /query endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the response times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service:
|
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Types
Default Header
Headers automatically added to every outbound request.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key |
String |
Key for this type. |
x |
|
Value |
String |
Value for this type. |
x |
Default Query Param
Query parameters automatically added to every outbound request.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key |
String |
Key for this type. |
x |
|
Value |
String |
Value for this type. |
x |
Proxy
Configures a proxy for outbound connections.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
Hostname or IP address of the proxy server. |
x |
|
Port |
Number |
Port of the proxy server. |
x |
|
Username |
String |
Username to authenticate against the proxy server. |
||
Password |
String |
Password to authenticate against the proxy server. |
||
Non Proxy Hosts |
String |
Comma-separated list of hosts that the proxy must not be used against. |
TLS
Configures TLS to provide secure communications for the Mule app.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
Comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
Comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
Configures the TLS truststore. |
|||
Key Store |
Configures the TLS keystore. |
|||
Revocation Check |
Configures how to validate certificates. |
Truststore
Configures the truststore for TLS.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible. |
||
Password |
String |
Password used to protect the truststore. |
||
Type |
String |
Type of truststore. |
||
Algorithm |
String |
Encryption algorithm that the truststore uses. |
||
Insecure |
Boolean |
If |
Keystore
Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible. |
||
Type |
String |
Type of store used. |
||
Alias |
String |
Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file. |
||
Key Password |
String |
Password used to protect the private key. |
||
Password |
String |
Password used to protect the keystore. |
||
Algorithm |
String |
Encryption algorithm that the keystore uses. |
Standard Revocation Check
Configures standard revocation checks for TLS certificates.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Which elements to verify in the certificate chain:
|
||
Prefer Crls |
Boolean |
How to check certificate validity:
|
||
No Fallback |
Boolean |
Whether to use the secondary method to check certificate validity:
|
||
Soft Fail |
Boolean |
What to do if the revocation server can’t be reached or is busy:
|
Custom OCSP Responder
Configures a custom OCSP responder for certification revocation checks.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. |
CRL File
Specifies the location of the certification revocation list (CRL) file.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the CRL file. |
Reconnection
Configures a reconnection strategy for an operation.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:
|
||
Reconnection Strategy |
Reconnection strategy to use. |
Reconnect
Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often to attempt to reconnect, in milliseconds. |
||
Blocking |
Boolean |
If |
||
Count |
Number |
How many reconnection attempts the Mule app can make. |
Reconnect Forever
Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often the Mule app attempts to reconnect to the remote service or API, in milliseconds. |
||
Blocking |
Boolean |
If |
Expiration Policy
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it is considered eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
Time unit for the Max Idle Time field. |
HTTP Response Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Status Code |
Number |
HTTP status code of the response. |
x |
|
Headers |
Object |
Map of HTTP headers in the message. |
x |
|
Reason Phrase |
String |
HTTP reason phrase of the response. |
x |
Repeatable In Memory Stream
Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value. |
||
Buffer Size Increment |
Number |
Amount by which the buffer size expands if it exceeds its initial size. Setting a value of |
||
Max Buffer Size |
Number |
Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a |
||
Buffer Unit |
Enumeration, one of:
|
Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields. |
Repeatable File Store Stream
Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size |
Number |
Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:
|
||
Buffer Unit |
Enumeration, one of:
|
Unit for the In Memory Size field. |