Salesforce Composite Connector 2.6 Reference - Mule 4
Configurations
Default Configuration
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
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. |
Connection Types
OAuth Username Password
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
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. According to Salesforce it should be |
|
|
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. |
|||
Host |
String |
Hostname of the proxy. If this property is not set, then no proxy is used, otherwise a proxy is used, but a proxy host must be specified. |
||
Port |
Number |
Port of the proxy. If host is set then this property must be set and 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, otherwise this value must be specified. |
||
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 will be converted to 0. |
5 |
|
Time unit |
Enumeration, one of:
|
Time unit to be used for the responseTimeout parameter. |
SECONDS |
|
Connection Timeout |
Number |
The socket connection timeout value. This attribute works in tandem with #connectionTimeoutUnit. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
A TimeUnit that qualifies the #connectionTimeout |
SECONDS |
|
Tls configuration |
Protocol to use for communication. Valid values are HTTP and HTTPS. When using HTTPS the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then, you must configure at least the keystore in the tls:context child element of this listener-config. |
HTTP |
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 |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Request Body |
Object |
The request body. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
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. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Execute Composite Batch
<salesforce-composite:execute-composite-batch>
Parameters
| 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. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
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 |
A retry strategy in case of connectivity errors |
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 |
|---|---|---|---|---|
Configuration |
String |
Name of the configuration to use |
x |
|
Request Body |
Object |
Request body |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Create Result |
Object |
The result of the create subrequest. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Delete Result |
Object |
The result of the delete subrequest. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Post Get Limits
<salesforce-composite:post-get-limits>
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 |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Get Limits Result |
Object |
The result of the create subrequest. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Query |
String |
The query that was used in the |
x |
|
Query Result |
Object |
The result of the query subrequest. |
|
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Post Query All
<salesforce-composite:post-query-all>
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 preQueryAll(String, java.util.Map).
Parameters
| 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. |
|
|
Streaming Strategy |
|
Configure to use repeatable streams. |
||
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
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. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Search Result |
Object |
The result of the search subrequest. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Update Result |
Object |
The result of the update subrequest. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
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. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Pre Query
<salesforce-composite:pre-query>
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 |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Query |
String |
The query that is run in |
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Query |
String |
The query that is run in |
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
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. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Search |
String |
The SOSL string that is run in executeCompositeBatch. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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. |
x |
|
Type |
String |
Type of object that is created. |
x |
|
SObject |
Object |
Object to create as a map that sticks to metadata for a selected type. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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. |
x |
|
Request Body |
Object |
The request body. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Upsert sObject Collections
<salesforce-composite:upsert-sobject-collections>
Upsert up to 200 records of same type and return a list of SaveResult objects. You 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. |
x |
|
Type |
String |
The sObject type. |
x |
|
External Field Name |
String |
The name of the external field for this sobject type. |
x |
|
Request Body |
Object |
The request body. |
|
|
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. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Types
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 |
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. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
true |
Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect. |
||
blocking |
Boolean |
If false, the reconnection strategy runs in a separate, non-blocking thread. |
true |
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:
|
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 be 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:
|
The unit in which maxInMemorySize is expressed. |
TLS Configuration
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Trust Store Configuration |
Contains the configuration parameters for the truststore configuration |
|||
Key Store Configuration |
Contains the configuration parameters for the keystore configuration |
|||
Advanced |
Contains advanced configuration parameters for TLS. |
Truststore Configuration
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
Defines the location of the truststore 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 truststore that is specified in the Path. |
||
Type |
Enumeration, one of:
|
Defines the type of the truststore to use (such as JKS, JCEKS, or PKCS12). |
JKS |
|
Algorithm |
String |
Defines the truststore algorithm. |
||
Insecure |
Boolean |
If |
False |
Keystore Configuration
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Type |
Enumeration, one of:
|
Defines the type of the keystore (such as JKS, JCEKS, or PKCS12). |
JKS |
|
Path |
String |
Defines the location of the keystore to use, which will be resolved relative to the current classpath and file system, if possible. |
||
Alias |
String |
Defines the alias of the key to use when the keystore 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 keystore that is specified in the Path. |
||
Algorithm |
String |
Defines the truststore algorithm. |
Advanced TLS Configuration
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enable Protocols |
String |
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. |
|
Enable Chiper Suites |
String |
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. |