Salesforce Composite Connector 2.13 Reference - Mule 4

Configurations

Default Configuration

Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	OAuth v2.0 OAuth JWT OAuth SAML OAuth Username Password Token Connection	The connection types to provide to this configuration.	x
Expiration Policy	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.

Name

Type

Description

Default Value

Required

Name

String

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

Connection

OAuth v2.0
OAuth JWT
OAuth SAML
OAuth Username Password
Token Connection

The connection types to provide to this configuration.

Expiration Policy

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.

Connection Types

OAuth v2.0

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
TLS configuration	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`.
Host	String	Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.
Port	Number	Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.
Username	String	Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.
Password	String	Password used to authenticate against the proxy.
Response timeout	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
Response timeout unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit to use for the Response Timeout parameter.	SECONDS
Connection Timeout	Number	The socket connection timeout value. This attribute works in tandem with Connection Timeout Unit.	30
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Connection Timeout.	SECONDS
Reconnection	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.
Consumer Key	String	The OAuth consumerKey as registered with the service provider.		x
Consumer Secret	String	The OAuth consumerSecret as registered with the service provider.		x
Authorization Url	String	The service provider’s authorization endpoint URL. The default is `https://login.salesforce.com/services/oauth2/authorize`.
Access Token Url	String	The service provider’s accessToken endpoint URL. The default is `https://login.salesforce.com/services/oauth2/token`.
Scopes	String	The OAuth scopes to request during the dance. If not provided, it defaults to the scopes provided in the annotation.
Resource Owner Id	String	The resource owner ID that each component uses if it is not otherwise referenced.
Before	String	The name of a flow to execute immediately before starting the OAuth dance.
After	String	The name of a flow to execute immediately after an accessToken is received.
Listener Config	String	A reference to a `<http:listener-config />` to use to create the listener that receives the access token callback endpoint.		x
Callback Path	String	The path of the access token callback endpoint.		x
Authorize Path	String	The path of the local HTTP endpoint that triggers the OAuth dance.		x
External Callback Url	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.
Object Store	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

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.

Host

String

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

Port

Number

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

Username

String

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

Password

String

Password used to authenticate against the proxy.

Response timeout

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.

Response timeout unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit to use for the Response Timeout parameter.

SECONDS

Connection Timeout

Number

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

Connection Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Reconnection

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.

Consumer Key

String

The OAuth consumerKey as registered with the service provider.

Consumer Secret

String

The OAuth consumerSecret as registered with the service provider.

Authorization Url

String

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

Access Token Url

String

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

Scopes

String

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

Resource Owner Id

String

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

Before

String

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

After

String

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

Listener Config

String

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

Callback Path

String

The path of the access token callback endpoint.

Authorize Path

String

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

External Callback Url

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.

Object Store

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.

OAuth JWT

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
TLS configuration	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`.
Host	String	Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.
Port	Number	Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.
Username	String	Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.
Password	String	Password used to authenticate against the proxy.
Response timeout	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
Response timeout unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit to use for the Response Timeout parameter.	SECONDS
Connection Timeout	Number	The socket connection timeout value. This attribute works in tandem with Connection Timeout Unit.	30
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Connection Timeout.	SECONDS
Consumer Key	String	Consumer key for the Salesforce-connected app.		x
Key Store	String	Path to the key store used to sign data during authentication.		x
Store Password	String	Password of the key store.		x
Certificate Alias	String	Alias of the certificate.
Principal	String	Username of the Salesforce user on whose behalf to take action.		x
Token Endpoint	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.
Audience 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	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

TLS Configuration

Host

String

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

Port

Number

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

Username

String

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

Password

String

Password used to authenticate against the proxy.

Response timeout

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.

Response timeout unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit to use for the Response Timeout parameter.

SECONDS

Connection Timeout

Number

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

Connection Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Consumer Key

String

Consumer key for the Salesforce-connected app.

Key Store

String

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

Store Password

String

Password of the key store.

Certificate Alias

String

Alias of the certificate.

Principal

String

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

Token Endpoint

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.

Audience 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

Reconnection

OAuth SAML

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
TLS configuration	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`.
Host	String	Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.
Port	Number	Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.
Username	String	Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy.
Password	String	Password used to authenticate against the proxy.
Response timeout	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
Response timeout unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit to use for the Response Timeout parameter.	SECONDS
Connection Timeout	Number	The socket connection timeout value. This attribute works in tandem with Connection Timeout Unit.	30
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Connection Timeout.	SECONDS
Consumer Key	String	Consumer key for the Salesforce-connected app.		x
Key Store	String	Path to the key store used to sign data during authentication.		x
Store Password	String	Password of the key store.		x
Certificate Alias	String	Alias of the certificate.
Principal	String	Username of the Salesforce user on whose behalf to take action.		x
Token Endpoint	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	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

TLS Configuration

Host

String

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

Port

Number

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

Username

String

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

Password

String

Password used to authenticate against the proxy.

Response timeout

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.

Response timeout unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit to use for the Response Timeout parameter.

SECONDS

Connection Timeout

Number

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

Connection Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Consumer Key

String

Consumer key for the Salesforce-connected app.

Key Store

String

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

Store Password

String

Password of the key store.

Certificate Alias

String

Alias of the certificate.

Principal

String

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

Token Endpoint

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

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

OAuth Username Password

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
TLS configuration	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
Host	String	Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.
Port	Number	Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.
Username	String	Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.
Password	String	Password used to authenticate against the proxy.
Response Timeout	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
Time unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit to use for the Response Timeout parameter.	SECONDS
Connection Timeout	Number	The socket connection timeout value. This attribute works in tandem with Connection Timeout Unit.	30
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the Connection Timeout.	SECONDS
Consumer Key	String	Consumer key for 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
Security Token	String	User’s security token. It can be omitted if your IP has been allowlisted on Salesforce.
Token Endpoint	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	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

TLS Configuration

HTTP

Host

String

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

Port

Number

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

Username

String

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

Password

String

Password used to authenticate against the proxy.

Response Timeout

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.

Time unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit to use for the Response Timeout parameter.

SECONDS

Connection Timeout

Number

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

Connection Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Consumer Key

String

Consumer key for Salesforce-connected app.

Consumer Secret

String

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

Username

String

Username used to initialize the session.

Password

String

Password used to authenticate the user

Security Token

String

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

Token Endpoint

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

Reconnection

Token Connection

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Session Id	String	Session ID.		x
Instance Url	String	Instance URL.		x
TLS configuration	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`
Host	String	Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.
Port	Number	Port of the proxy. If Host is set, then this property is required and the value cannot be a negative number.
Username	String	Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.
Password	String	Password used to authenticate against the proxy.
Response timeout	Number	How long Mule waits for a response to complete before the request times out.	`5`
Response timeout unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Response timeout field.	`SECONDS`
Connection Timeout	Number	Socket connection timeout value.	30
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Connection Timeout field.	`SECONDS`
Reconnection	Reconnection	Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Session Id

String

Session ID.

Instance Url

String

Instance URL.

TLS configuration

TLS Configuration

HTTP

Host

String

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

Port

Number

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

Username

String

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

Password

String

Password used to authenticate against the proxy.

Response timeout

Number

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

5

Response timeout unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit for the Response timeout field.

SECONDS

Connection Timeout

Number

Socket connection timeout value.

Connection Timeout Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

Time unit for the Connection Timeout field.

SECONDS

Reconnection

Reconnection

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

Operations

Create Sobject Collections

<salesforce-composite:create-sobject-collections>

Add up to 200 records and return a list of SaveResult objects. You can roll back the entire request if an error occurs.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Request Body	Object	The request body.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Request Body

Object

The request body.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Array of Object

Attributes Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Create sObject Tree

<salesforce-composite:create-sobject-tree>

Sends a list of sObject trees to Salesforce to be created.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
SObject Root Type	String	The sObject type of the root of the trees.		x
SObject Tree	Array of Object	A list of maps containing representing the list of trees that need to be created.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

SObject Root Type

String

The sObject type of the root of the trees.

SObject Tree

Array of Object

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

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

Attributes Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Delete sObject Collections

<salesforce-composite:delete-sobject-collections>

Delete up to 200 records and return a list of DeleteResult objects. You can roll back the entire request if an error occurs.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Ids	Array of String	The IDs of the entities to be deleted.		x
All Or None	Boolean	Indicates whether to roll back the entire request when the deletion of any object fails.	false
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Ids

Array of String

The IDs of the entities to be deleted.

All Or None

Boolean

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

false

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Array of Object

Attributes Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Execute Composite Batch

<salesforce-composite:execute-composite-batch>

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Sub Requests	Array of Object	The list of subrequests to execute.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Sub Requests

Array of Object

The list of subrequests to execute.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

Attributes Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Execute Composite Graph

<salesforce-composite:execute-composite-graph>

Performs composite requests by executing a series of REST API requests in a single call.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use		x
Graphs	Array of Object	List of graphs to execute	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Configuration

String

Name of the configuration to use

Graphs

Array of Object

List of graphs to execute

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type a

Object

Attributes Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:VALIDATION
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:INVALID_SESSION

Execute Composite Request

<salesforce-composite:execute-composite-request>

Execute a series of REST API requests in a single call. You can use the output of one request as the input to a subsequent request. The response bodies and HTTP statuses of the requests are returned in a single response body. The entire request counts as a single call toward your API limits.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use		x
Request Body	Object	Request body	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

Name of the configuration to use

Request Body

Object

Request body

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

Attributes Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Get sObject Collections

<salesforce-composite:get-sobject-collections>

Retrieve one or more records of the same object type.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Type	String	The sObject type of the root of the trees.		x
List of ids	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
List of fields	Array of String	A list of fields to include in the response.		x
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Type

String

The sObject type of the root of the trees.

List of ids

Array of String

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

List of fields

Array of String

A list of fields to include in the response.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Array of Object

Attributes Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Post Create

<salesforce-composite:post-create>

Provide metadata for the result of a create. This operation takes as input one record from the result returned by executeCompositeBatch(String, java.util.List), which belongs to a create subrequest generated by preCreate(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Create Result	Object	The result of the create subrequest.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Create Result

Object

The result of the create subrequest.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Post Delete

<salesforce-composite:post-delete>

Provide metadata for the result of a delete. This operation takes as input one record from the result returned by executeCompositeBatch(String, java.util.List), which belongs to a delete subrequest generated by preDelete(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Delete Result	Object	The result of the delete subrequest.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Delete Result

Object

The result of the delete subrequest.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Post Get Limits

<salesforce-composite:post-get-limits>

Provide metadata for the result of a get limits request. This operation takes as input one record from the result returned by executeCompositeBatch(String, java.util.List), which belongs to a get limits subrequest generated by preGetLimits().

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Get Limits Result	Object	The result of the create subrequest.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Get Limits Result

Object

The result of the create subrequest.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Post Query

<salesforce-composite:post-query>

Provide metadata for the result of a query. This operation takes as input one record from the result returned by executeCompositeBatch(String, java.util.List), which belongs to a query subrequest generated by preQuery(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Query	String	The query that was used in the `preQuery` operation - needed for metadata.		x
Query Result	Object	The result of the query subrequest.	`#[payload]`
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Query

String

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

Query Result

Object

The result of the query subrequest.

#[payload]

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Array of Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Post Query All

<salesforce-composite:post-query-all>

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Query Result	Object	The result of the create subrequest.	`#[payload]`
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Query Result

Object

The result of the create subrequest.

#[payload]

Streaming Strategy

Repeatable In Memory Iterable
Repeatable File Store Iterable
non-repeatable-iterable

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

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Array of Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Post Retrieve

<salesforce-composite:post-retrieve>

Provide metadata for the result of a retrieve. This operation takes as input one record from the result returned by executeCompositeBatch(String, java.util.List), which belongs to a retrieve subrequest generated by preRetrieve(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Type	String	The type of the retrieved object - used for metadata.		x
Retrieve Data	Object	The result of the retrieve subrequest.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Type

String

The type of the retrieved object - used for metadata.

Retrieve Data

Object

The result of the retrieve subrequest.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Post Search

<salesforce-composite:post-search>

Provide metadata for the result of a search. This operation takes as input one record from the result returned by executeCompositeBatch(String, java.util.List), which belongs to a search subrequest generated by preSearch(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Search Result	Object	The result of the search subrequest.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Search Result

Object

The result of the search subrequest.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Array of Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Post Update

<salesforce-composite:post-update>

Provide metadata for the result of an update. This operation takes as input one record from the result returned by executeCompositeBatch(String, java.util.List), which belongs to an update subrequest generated by preUpdate(String, java.util.Map).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Update Result	Object	The result of the update subrequest.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Update Result

Object

The result of the update subrequest.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Pre Create

<salesforce-composite:pre-create>

Provide metadata for a create based on an object that is created and generates a subrequest for execution by executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Type	String	Type of object to create.		x
S Object	Object	Object to create as a map that sticks to metadata for a selected type.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Type

String

Type of object to create.

S Object

Object

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

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Pre Delete

<salesforce-composite:pre-delete>

Provide metadata for a delete based on an object that is deleted and generates a subrequest for execution by executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Type	String	Type of object that is deleted.		x
Id	String	The ID of the object that is deleted.		x
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Type

String

Type of object that is deleted.

String

The ID of the object that is deleted.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Pre Get Limits

<salesforce-composite:pre-get-limits>

Provide metadata for getLimits and generate a subrequest for execution by executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Pre Query

<salesforce-composite:pre-query>

Provides metadata for a query based on an object that is queried, and generates a subrequest for execution by executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Query	String	The query that is run in `executeCompositeBatch`.		x
Parameters	Object	The parameters to use in a parameterized query.
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Query

String

The query that is run in executeCompositeBatch.

Parameters

Object

The parameters to use in a parameterized query.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Pre Query All

<salesforce-composite:pre-query-all>

Provide metadata for a query based on an object that is queried and generates a subrequest for execution by executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Query	String	The query that is run in `executeCompositeBatch`.		x
Parameters	Object	The parameters to use in a parameterized query.
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Query

String

The query that is run in executeCompositeBatch.

Parameters

Object

The parameters to use in a parameterized query.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Pre Retrieve

<salesforce-composite:pre-retrieve>

Provide metadata for a retrieve based on an object that is retrieved and generates a subrequest for execution by executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Retrieve Data	Object	Object to retrieve as a map that sticks to metadata for a selected type.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Retrieve Data

Object

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

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Pre Search

<salesforce-composite:pre-search>

Provide the user a way to input a SOSL String and generate a subrequest for execution by executeCompositeBatch(java.util.List).

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Search	String	The SOSL string that is run in executeCompositeBatch.	`#[payload]`
Target Variable	String	Name of the variable in which to store the operation’s output
Target Value	String	Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

Search

String

The SOSL string that is run in executeCompositeBatch.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Pre Update

<salesforce-composite:pre-update>

Provide metadata for a create based on an object that is created and generates a subrequest for execution by executeCompositeBatch(String, java.util.List).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

Type

String

Type of object that is created.

SObject

Object

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

#[payload].

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Unauthorize

<salesforce-composite:unauthorize>

Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without repeating the authorization dance.

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Resource Owner Id

String

The ID of the resource owner for whom to invalidate access

For Configurations

Default Configuration

Update sObject Collections

<salesforce-composite:update-sobject-collections>

Update up to 200 records and return a list of SaveResult objects. You can roll back the entire request if an error occurs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

Request Body

Object

The request body.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Array of Object

Attributes Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Upsert sObject Collections

<salesforce-composite:upsert-sobject-collections>

Upsert up to 200 records of same type and return a list of SaveResult objects. You can roll back the entire request if an error occurs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

Type

String

The sObject type.

External Field Name

String

The name of the external field for this sobject type.

Request Body

Object

The request body.

#[payload]

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors.

Output

Type a

Array of Object

Attributes Type a

Object

For Configurations

Default Configuration

Throws

SALESFORCE-COMPOSITE:CONNECTIVITY
SALESFORCE-COMPOSITE:INVALID_SESSION
SALESFORCE-COMPOSITE:RETRY_EXHAUSTED
SALESFORCE-COMPOSITE:TRANSACTION
SALESFORCE-COMPOSITE:TRANSFORMATION
SALESFORCE-COMPOSITE:UNKNOWN
SALESFORCE-COMPOSITE:VALIDATION

Types

TLS Configuration

Field

Type

Description

Default Value

Required

Enabled Protocols

String

A comma separated list that defines the enabled TLS protocols, which must be a subset of the globally enabled TLS protocols.

By default, the globally enabled TLS protocols are used.

Enabled Chiper Suites

String

A comma separated list that defines the enabled TLS cipher suites, which must be a subset of the globally enabled cipher suites.

By default, the globally enabled cipher suites are used.

Trust Store Configuration

Trust Store Configuration

Contains the configuration parameters for the trust store configuration

Key Store Configuration

Key Store Configuration

Contains the configuration parameters for the key store configuration

Revocation Check

Standard Revocation Check
Custom OCSP Responder
CRL File

Trust Store Configuration

Field Type Description Default Value Required

Path

String

Defines the location of the trust store to use, which will be resolved relative to the current classpath and file system, if possible. A password is also required.

Password

String

The password to access the trust store that is specified in the path.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store Configuration

Field

Type

Description

Default Value

Required

Path

String

Defines the location of the key store to use, which will be resolved relative to the current classpath and file system, if possible.

Type

String

The type of store used.

Alias

String

Defines the alias of the key to use when the key store contains many private keys. By default, the first key in the file is used.

Key Password

String

Defines the password used to protect the private key.

Password

String

Defines the password to access the key store that is specified in the path.

Algorithm

String

Defines the algorithm used by the key store.

Standard Revocation Check

Field

Type

Description

Default Value

Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer CRLs

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot be reached or is busy.

Custom OCSP Responder

Field

Type

Description

Default Value

Required

URL

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response, if present. The certificate must be in the trust store.

CRL File

Field

Type

Description

Default Value

Required

Path

String

The path to the CRL file.

Reconnection

Field

Type

Description

Default Value

Required

Fails Deployment

Boolean

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.

Reconnection Strategy

Reconnect
Reconnect Forever

The reconnection strategy to use.

Reconnect

Field

Type

Description

Default Value

Required

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

Reconnect Forever

Field

Type

Description

Default Value

Required

Frequency

Number

How often in milliseconds to reconnect.

Expiration Policy

Field

Type

Description

Default Value

Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit that qualifies the maxIdleTime attribute.

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of instances that is initially allowed to be kept 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 maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

The maximum amount of instances to keep in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

BYTE
KB
MB
GB

The unit in which maxInMemorySize is expressed.