Salesforce Composite Connector 2.18 Reference - Mule 4

String

The name for this configuration. Connectors reference the configuration with this name.

x

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

TLS Configuration

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the tls:context child element of the listener-config.

String

Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.

Number

Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.

String

Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.

String

Password used to authenticate against the proxy.

Number

Wait time until a response is received. This attribute works in tandem with Response Timeout Unit. Values less than one millisecond are converted to 0.

5

Enumeration, one of:

Time unit to use for the Response Timeout parameter.

SECONDS

Number

The socket connection timeout value. This attribute works in tandem with Connection Timeout Unit.

30

Enumeration, one of:

A time unit that qualifies the Connection Timeout.

SECONDS

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

String

The OAuth consumerKey as registered with the service provider.

x

String

The OAuth consumerSecret as registered with the service provider.

x

String

The service provider’s authorization endpoint URL. The default is https://login.salesforce.com/services/oauth2/authorize.

String

The service provider’s accessToken endpoint URL. The default is https://login.salesforce.com/services/oauth2/token.

String

The OAuth scopes to request during the dance. If not provided, it defaults to the scopes provided in the annotation.

String

The resource owner ID that each component uses if it is not otherwise referenced.

String

The name of a flow to execute immediately before starting the OAuth dance.

String

The name of a flow to execute immediately after an accessToken is received.

String

A reference to a <http:listener-config /> to use to create the listener that receives the access token callback endpoint.

x

String

The path of the access token callback endpoint.

x

String

The path of the local HTTP endpoint that triggers the OAuth dance.

x

String

If the callback endpoint is behind a proxy or accessed through a non direct URL, use this parameter to tell the OAuth provider the URL to use to access the callback.

String

A reference to the object store to use to store each resource owner ID’s data. If an object store is not specified, Mule automatically provisions the default object store.

TLS Configuration

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the tls:context child element of the listener-config.

String

Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.

Number

Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.

String

Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.

String

Password used to authenticate against the proxy.

Number

Wait time until a response is received. This attribute works in tandem with Response Timeout Unit. Values less than one millisecond are converted to 0.

5

Enumeration, one of:

Time unit to use for the Response Timeout parameter.

SECONDS

Number

The socket connection timeout value. This attribute works in tandem with Connection Timeout Unit.

30

Enumeration, one of:

A time unit that qualifies the Connection Timeout.

SECONDS

String

Consumer key for the Salesforce-connected app.

x

String

Path to the key store used to sign data during authentication.

x

String

Password of the key store.

x

String

Alias of the certificate.

String

Username of the Salesforce user on whose behalf to take action.

x

String

URL pointing to the server responsible for providing the authentication token. The default is https://login.salesforce.com/services/oauth2/token.

If implementation is for a community, https://acme.force.com/customers/services/oauth2/token, where acme.force.com/customers is your community URL.

String

The audience identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.

Use the authorization server’s URL for the audience value: https://login.salesforce.com. For testing, use: https://test.salesforce.com. For a community implementation, use: https://community.force.com/customers.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

TLS Configuration

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the tls:context child element of the listener-config.

String

Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.

Number

Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.

String

Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy.

String

Password used to authenticate against the proxy.

Number

Wait time until a response is received. This attribute works in tandem with Response Timeout Unit. Values less than one millisecond are converted to 0.

5

Enumeration, one of:

Time unit to use for the Response Timeout parameter.

SECONDS

Number

The socket connection timeout value. This attribute works in tandem with Connection Timeout Unit.

30

Enumeration, one of:

A time unit that qualifies the Connection Timeout.

SECONDS

String

Consumer key for the Salesforce-connected app.

x

String

Path to the key store used to sign data during authentication.

x

String

Password of the key store.

x

String

Alias of the certificate.

String

Username of the Salesforce user on whose behalf to take action.

x

String

URL pointing to the server responsible for providing the authentication token. The default is https://login.salesforce.com/services/oauth2/token.

If implementation is for a community, https://acme.force.com/customers/services/oauth2/token, where acme.force.com/customers is your community URL.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

TLS Configuration

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the tls:context child element of the listener-config.

HTTP

String

Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.

Number

Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.

String

Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.

String

Password used to authenticate against the proxy.

Number

Wait time until a response is received. This attribute works in tandem with Time Unit. Values less than one millisecond are converted to 0.

5

Enumeration, one of:

Time unit to use for the Response Timeout parameter.

SECONDS

Number

The socket connection timeout value. This attribute works in tandem with Connection Timeout Unit.

30

Enumeration, one of:

A time unit that qualifies the Connection Timeout.

SECONDS

String

Consumer key for Salesforce-connected app.

x

String

Your application’s client secret (consumer secret in Remote Access Detail).

x

String

Username used to initialize the session.

x

String

Password used to authenticate the user

x

String

User’s security token. It can be omitted if your IP has been allowlisted on Salesforce.

String

URL pointing to the server responsible for providing the authentication token. The default is https://login.salesforce.com/services/oauth2/token.

If implementation is for a community, https://acme.force.com/customers/services/oauth2/token, where acme.force.com/customers is your community URL.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

String

Session ID.

x

String

Instance URL.

x

TLS Configuration

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the tls:context child element of the listener-config.

HTTP

String

Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.

Number

Port of the proxy. If Host is set, then this property is required and the value cannot be a negative number.

String

Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.

String

Password used to authenticate against the proxy.

Number

How long Mule waits for a response to complete before the request times out.

5

Enumeration, one of:

Time unit for the Response timeout field.

SECONDS

Number

Socket connection timeout value.

30

Enumeration, one of:

Time unit for the Connection Timeout field.

SECONDS

Reconnection

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

String

The name of the configuration to use.

x

Object

The request body.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The sObject type of the root of the trees.

x

Array of Object

A list of maps containing representing the list of trees that need to be created.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Array of String

The IDs of the entities to be deleted.

x

Boolean

Indicates whether to roll back the entire request when the deletion of any object fails.

false

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Array of Object

The list of subrequests to execute.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

Name of the configuration to use

x

Array of Object

List of graphs to execute

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors

String

Name of the configuration to use

x

Object

Request body

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The sObject type of the root of the trees.

x

Array of String

A list of one or more IDs of the objects to return. All IDs must belong to the same object type.

x

Array of String

A list of fields to include in the response.

x

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Object

The result of the create subrequest.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Object

The result of the delete subrequest.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Object

The result of the create subrequest.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The query that was used in the preQuery operation - needed for metadata.

x

Object

The result of the query subrequest.

#[payload]

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Object

The result of the create subrequest.

#[payload]

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The type of the retrieved object - used for metadata.

x

Object

The result of the retrieve subrequest.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Object

The result of the search subrequest.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Object

The result of the update subrequest.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

Type of object to create.

x

Object

Object to create as a map that sticks to metadata for a selected type.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

Type of object that is deleted.

x

String

The ID of the object that is deleted.

x

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The query that is run in executeCompositeBatch.

x

Object

The parameters to use in a parameterized query.

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The query that is run in executeCompositeBatch.

x

Object

The parameters to use in a parameterized query.

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Object

Object to retrieve as a map that sticks to metadata for a selected type.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The SOSL string that is run in executeCompositeBatch.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

Type of object that is created.

x

Object

Object to create as a map that sticks to metadata for a selected type.

#[payload].

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The ID of the resource owner for whom to invalidate access

String

The name of the configuration to use.

x

Object

The request body.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The sObject type.

x

String

The name of the external field for this sobject type.

x

Object

The request body.

#[payload]

String

Name of the variable in which to store the operation’s output

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

A retry strategy in case of connectivity errors.