Contact Free trial Login

Salesforce Composite Connector Reference - Mule 4

Support Version: Select

Salesforce Composite Connector v2.2.0

Configurations


Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name of 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 the runtime considers it eligible for expiration. To optimize resources, Mule expires instances that are not in use without impacting performance or resource utilization.

Connection Types

OAuth Username Password
Parameters
Name Type Description Default Value Required

Consumer Key

String

Consumer key for the Salesforce connected app.

x

Consumer Secret

String

Your app’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, which can be omitted if your IP address has been white listed in Salesforce.

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

When an app 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 set, then a proxy host must be specified. If not set, no proxy is used.

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 going to use against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Operations

Create SObject Collections

<salesforce-composite:create-sobject-collections>

Add up to 200 records and a list of SaveResult objects. If an error occurs, you can choose to roll back the entire request.

To roll back a request if a create fails, set the allOrNone parameter to true in the operation payload:

{
	"allOrNone": true,
	"sObjects": [sObject1, sObject2, ...]
}

Parameters

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

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

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 create.

To roll back a request if a create fails, set the allOrNone parameter to true in the operation payload:

{
	"allOrNone": true,
	"sObjects": [sObject1, sObject2, ...]
}

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

SObject Root Type

String

SObject type for the root of the trees.

x

SObject Tree

Array of Object

A list of maps containing the list of trees to create.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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. If an error occurs, you can choose to roll back the entire request using the All or None field.

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 delete.

x

All Or None

Boolean

Indicate whether to roll back the entire request if an object delete fails.

false

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

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>

Execute up to 25 subrequests in a single request. The response bodies and HTTP statuses of the subrequests in the batch are returned in a single response body. Subrequests are independent, and you can’t pass information between them.

If a subrequest fails, commits made by previous subrequests are not rolled back.

The API version of the resource accessed in each subrequest must be no earlier than 34.0 and no later than the Batch version in the top-level request.

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.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 Request

<salesforce-composite:execute-composite-request>

Execute a series of REST API requests in a single call. You can use the output of a request as the input to a subsequent request. The response body and HTTP status for each request is returned as 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

The name of the configuration to use.

x

Request Body

Object

The request body.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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

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

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

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 a record from the result returned by the executeCompositeBatch(String, java.util.List) function, which creates a subrequest generated by the preCreate(String, java.util.Map) function.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Result

Object

The result of creating a subrequest.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 a record from the result returned by the executeCompositeBatch(String, java.util.List) function, which deletes a subrequest generated by the preDelete(String, java.util.Map) function.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Delete Result

Object

The result of a delete subrequest.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 create. This operation takes as input one record from the result returned by the executeCompositeBatch(String, java.util.List) function, which creates a subrequest generated by the preCreate(String, java.util.Map) function.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Get Limits Result

Object

The result of a create subrequest.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 query. This operation takes as input a record from the result returned by the executeCompositeBatch(String, java.util.List) function, which queries a subrequest generated by the preQuery(String, java.util.Map) function.

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 `preQueryAll operation - needed for metadata.

x

Query Result

Object

The result of a query subrequest.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

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>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query Result

Object

The result of a create subrequest.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

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 retrieve. This operation takes as input one record from the result returned by the executeCompositeBatch(String, java.util.List) function, which retrieves a subrequest generated by the preRetrieve(String, java.util.Map) function.

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, which is used for metadata.

x

Retrieve Data

Object

The result of a retrieve subrequest.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 a record from the result returned by the executeCompositeBatch(String, java.util.List) function, which searches subrequests generated by the preSearch(String, java.util.Map) function.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Search Result

Object

The result of a search subrequest.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

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 a record from the result returned by the executeCompositeBatch(String, java.util.List) function, which updates a subrequest generated by the preUpdate(String, java.util.Map) function.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update Result

Object

The result of an update subrequest.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 to create, and generate a subrequest for execution by the executeCompositeBatch(String, java.util.List) function.

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

SObject

Object

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

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 the object to delete, and generate a subrequest to execute by the executeCompositeBatch(String, java.util.List) function.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The type of object to delete.

x

Id

String

The ID of the object to delete.

x

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 to execute by the executeCompositeBatch(String, java.util.List) function.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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>

Provide metadata for a query based on an object to query, and generate a subrequest to execute by the executeCompositeBatch(String, java.util.List) function.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

The query to run in executeCompositeBatch.

x

Parameters

Object

The parameters to use in a parameterized query.

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 to query, and generate a subrequest to execute by the executeCompositeBatch(String, java.util.List) function.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

The query to run in executeCompositeBatch.

x

Parameters

Object

The parameters to use in a parameterized query.

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 to retrieve, and generate a subrequest to execute by the executeCompositeBatch(String, java.util.List) function.

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 type.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 to execute by the executeCompositeBatch(java.util.List) function.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Search

String

The SOSL string to run in executeCompositeBatch.

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

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 that is based on an object to create, and generate a subrequest to execute by the executeCompositeBatch(String, java.util.List) function.

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

SObject

Object

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

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SALESFORCE-COMPOSITE:CONNECTIVITY

  • SALESFORCE-COMPOSITE:INVALID_SESSION

  • SALESFORCE-COMPOSITE:RETRY_EXHAUSTED

  • SALESFORCE-COMPOSITE:TRANSACTION

  • SALESFORCE-COMPOSITE:TRANSFORMATION

  • SALESFORCE-COMPOSITE:UNKNOWN

  • SALESFORCE-COMPOSITE:VALIDATION

Update SObject Collections

<salesforce-composite:update-sobject-collections>

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

To roll back the request if an update fails, set the allOrNone parameter to true in the operation payload:

{
	"allOrNone": true,
	"sObjects": [sObject1, sObject2, ...]
}

Parameters

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

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

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. If an error occurs, you can roll back the entire request.

To roll back the request if an upsert fails, set the allOrNone parameter to true in the operation payload:

{
	"allOrNone": true,
	"sObjects": [sObject1, sObject2, ...]
}

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

#[payload]

Target Variable

String

A variable that stores the output of the Target Variable expression.

Target Value

String

An expression to evaluate against the operation’s output. Stores the output in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

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

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the app 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Max Idle Time 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 bufferSizeIncrement 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, and 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.

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.