Salesforce Marketing Cloud Connector 4.1 Reference - Mule 4

String

Base URL of the service on Salesforce Marketing Cloud to access from the connector. All other endpoints derive from this base URL.

x

Number

How long the connector waits before timing out when establishing a connection to the remote service.

Enumeration, one of:

Time unit for the Connection Timeout field.

SECONDS

Proxy Configuration

Configures a proxy for outbound connections.

String

URL of the WSDL file used by this connector. If unspecified, this parameter defaults to the service URL parameter host, but it appends /etframework.wsdl to the end.

String

Username used to initialize the session.

x

String

Password used to authenticate the user.

x

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

Base URL of the service on Salesforce Marketing Cloud to access from the connector. All other endpoints derive from this base URL.

x

Number

How long the connector waits before timing out when establishing a connection to the remote service.

Enumeration, one of:

Time unit for the Connection Timeout field.

SECONDS

Proxy Configuration

Configures a proxy for outbound connections.

String

URL of the WSDL file used by this connector. If unspecified, this parameter defaults to the service URL parameter host, but it appends /etframework.wsdl to the end.

String

Account ID.

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

OAuth client ID, as registered with the service provider.

x

String

OAuth client secret, as registered with the service provider.

x

String

URL of the service provider’s token endpoint.

https://{domain}.auth.marketingcloudapis.com/v2/token

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

String

Name of the configuration to use.

x

String

Specifies a date in the yyyy-MM-dd HH:mm:ss format, for example, 2017-03-17 16:30:40, to retrieve the selected objects.

Number

How long the consumer waits for a response before timing out.

Enumeration, one of:

Time unit for the Amount field.

String

Type of API object to retrieve.

x

ConfigurationProvider

Name of the configuration used to execute this component.

x

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Specifies a date in the yyyy-MM-dd HH:mm:ss format, for example, 2017-03-17 16:30:40, to retrieve the selected objects.

Number

How long the consumer waits for a response before timing out.

Enumeration, one of:

Time unit for the Amount field.

String

Type of API object to retrieve.

x

ConfigurationProvider

Name of the configuration used to execute this component.

x

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Array of Object

Array of one or more configurations to update.

#[payload]

Object

Options for the operation.

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Type of action to perform.

x

String

Type of object the action is performed on.

x

Number

How long the consumer waits for a response before timing out.

Enumeration, one of:

Time unit for the Amount field.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Array of Error Mapping

Set of error mappings.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Type of API object to create.

x

Array of Object

Array of one or more API objects.

#[payload]

Object

Options for the operation.

ConfigurationProvider

Name of the configuration used to execute this component.

x

Number

How long the consumer waits for a response before timing out.

Enumeration, one of:

Time unit for the Amount field.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Array of Error Mapping

Set of error mappings.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Type of object to delete.

x

Array of Object

Array of one or more API objects.

#[payload]

Object

Options for the operation.

ConfigurationProvider

Name of the configuration used to execute this component.

x

Number

How long the consumer waits for a response before timing out.

Enumeration, one of:

Time unit for the Amount field.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Array of Error Mapping

Set of error mappings.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Array of Object

Array of one or more definitions for the operation.

Service URL[payload]

Object

Options for the operation.

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Type of action to perform.

x

String

Type of object the action is performed on.

x

Number

How long the consumer waits for a response before timing out.

Enumeration, one of:

Time unit for the Amount field.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Array of Error Mapping

Set of error mappings.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Query describing the objects that you want to retrieve.

x

Object

Options for the operation.

ConfigurationProvider

Name of the configuration used to execute this component.

x

Configures how Mule processes streams. Repeatable streams are the default behavior.

Number

How long the consumer waits for a response before timing out.

Enumeration, one of:

Time unit for the Amount field.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Array of Error Mapping

Set of error mappings.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Type of object on which to do a schedule.

x

Array of Object

Array of one or more interactions in the operation.

#[payload]

Object

Schedule definition used for the operation.

x

Object

Options for the operation.

ConfigurationProvider

Name of the configuration used to execute this component.

x

Number

How long the consumer waits for a response before timing out.

Enumeration, one of:

Time unit for the Amount field.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Array of Error Mapping

Set of error mappings.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

ConfigurationProvider

Name of the configuration used to execute this component.

x

String

Name of the configuration to use.

x

String

Type of object to update.

x

Array of Object

Array of one or more API objects.

#[payload]

Object

Options for the operation.

ConfigurationProvider

Name of the configuration used to execute this component.

x

Number

How long the consumer waits for a response before timing out.

Enumeration, one of:

Time unit for the Amount field.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Array of Error Mapping

Set of error mappings.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Type of API object to upsert.

x

Array of Object

Array of one or more API objects.

#[payload]

Object

Options for the operation.

ConfigurationProvider

Name of the configuration used to execute this component.

x

Number

How long the consumer waits for a response before timing out.

Enumeration, one of:

Time unit for the Amount field.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Array of Error Mapping

Set of error mappings.

Retry strategy in case of connectivity errors.

String

Path to the CRL file.

String

URL of the OCSP responder.

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

Enumeration, one of:

Source of the error.

String

Target of the error.

x

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Enumeration, one of:

Time unit for the Max Idle Time field.

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

String

Type of keystore.

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

String

Password used to protect the private key.

String

Password used to protect the keystore.

String

Encryption algorithm that the keystore uses.

String

Hostname or IP address of the proxy server.

x

Number

Port of the proxy server.

x

String

Username to authenticate against the proxy server.

String

Password to authenticate against the proxy server.

String

Comma-separated list of hosts that the proxy must not be used against.

String

Domain to authenticate against the proxy.

Number

How often to attempt to reconnect, in milliseconds.

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Number

How many reconnection attempts the Mule app can make.

Number

How often to attempt to reconnect, in milliseconds.

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

Reconnection strategy to use.

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Redelivery Policy Message Identifier

One or more expressions that determine if a message was redelivered. This property can be set only if the Use Secure Hash field is false.

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Enumeration, one of:

Unit for the In Memory Objects field.

Number

Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max In Memory Size. Default value is 100 instances.

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand. A STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

100

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

Boolean

Which elements to verify in the certificate chain:

Boolean

How to check certificate validity:

Boolean

Whether to use the secondary method to check certificate validity:

Boolean

What to do if the revocation server can’t be reached or is busy:

String

Comma-separated list of protocols enabled for this context.

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Configures a revocation checking mechanism.

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

String

Password used to protect the truststore.

String

Type of truststore.

String

Encryption algorithm that the truststore uses.

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.