# mulesoft Salesforce Composite Connector - Full Documentation --- product: Salesforce Composite Connector version: 2.19 --- # Salesforce Composite Connector 2.19 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Composite enables you to work with the Salesforce Batch and SObject Tree APIs. The connector exposes convenient methods for preparing subordinate requests, executing them in one batch, and parsing the results. Salesforce Composite Connector also enables you to create SObject trees by using the **Create sobject tree** operation, which is separate from the batch operations. This connector provides DataSense for execution and to: - Prepare subordinate requests and then parse the responses - Create SObject trees For compatibility information and fixed issues, see Salesforce Composite Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce Composite API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Credentials to access the Salesforce Composite target resource - Anypoint Studio version 7.0 or later ## Authentication Types Salesforce Composite Connector connections use the following authentication types: - OAuth v2.0 - OAuth JWT - OAuth SAML - OAuth Username and Password - Token Connection For information about configuring these authentication types, see [Using Anypoint Studio to Configure Salesforce Composite Connector](https://docs.mulesoft.com/salesforce-composite-connector/2.19/salesforce-composite-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.19 --- # Salesforce Composite Connector 2.19 - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## SObject Tree Operation Example This example uses the following operations to create an SObject tree to connect to Salesforce and transform and output the results in JSON format: - HTTP **Listener** Accepts data from HTTP requests - **Transform Message** Transforms the HTTP input - **Create sobject tree** Connects with Salesforce and creates an SObject tree - **Transform Message** Outputs the results of the **Create sobject tree** operation in JSON format ![Studio flow with an HTTP Listener component, Transform components, and a Create operation](/mulesoft/current/en-us/salesforce-composite-connector/2.19/_images/salesforce-composite-studio-use-case.png) ### Add an HTTP Listener The HTTP **Listener** source operation initiates the flow when it detects an event in the `createSObjectTree` path. To add the listener and trigger the flow, follow these steps: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 3. Drag the **Listener** operation onto the canvas. 4. In the Listener properties window, set the **Path** field to `/createSObjectTree`. ### Add the First Transform Message Component The first Transform Message component uses input data to transform the HTTP input for the following Create operation. To add the component, follow these steps: 1. In the **Mule Palette** view, search for **Transform Message**. 2. Drag the **Transform Message** component onto the canvas, to the right of **Listener**. 3. Enter the name `Transform HTTP input for Create SObject Tree`. The following is an example of HTTP input for the Transform Message component: ```json { "records": [ { "ChildAccounts": { "records": [ { "Phone": "4321098765", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref5" }, "NumberOfEmployees": "10", "Name": "ChildAccount1" } ] }, "Contacts": { "records": [ { "Email": "sample@salesforce.com", "Title": "President", "attributes": { "objectType": "Contact", "referenceId": "ref6" }, "LastName": "Jones" } ] }, "Phone": "5556543210", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref4" }, "NumberOfEmployees": "101", "Name": "CreateSobjectTreeAccount2" }, { "Contacts": { "records": [ { "Email": "sample@salesforce.com", "Title": "President", "attributes": { "objectType": "Contact", "referenceId": "ref2" }, "LastName": "Smith" }, { "Email": "sample@salesforce.com", "Title": "Vice President", "attributes": { "objectType": "Contact", "referenceId": "ref3" }, "LastName": "Evans" } ] }, "Phone": "1234567890", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref1" }, "NumberOfEmployees": "100", "Name": "CreateSobjectTreeAccount1" } ] } ``` ### Add the Create SObject Tree Operation Add the Create SObject Tree operation to connect with Salesforce and create an SObject tree. To add the operation, follow these steps: 1. In the **Mule Palette** view, search for `salesforce` and select **Create sobject tree**. 2. Drag **Create sobject tree** operation to the right of **Transform Message**. 3. Click the green plus sign (**+**) to the right of **Connector configuration** to access the Salesforce Composite global element configuration fields. 4. In the **Create sobject tree** properties window, enter `Account` in the **SObject Root Type** field. 5. In the properties file `src/main/mule/mule-app.properties`, declare and enter values for the variables in the global element. ### Add the Second Transform Message Component The second Transform Message component transforms the output result into JSON. To add the component, follow these steps: 1. Drag **Transform Message** again to the right of **Create sobject tree**. 2. Enter the following: ```dataweave %dw 2.0 %output application/json payload --- { "Id": payload.Id, "Fields" : ["Id", "Name"], "Type": "Account" } ``` ### XML for the SObject Tree Operation Flow Paste this XML code into the **Configuration XML** tab of the Anypoint Studio canvas to experiment with the flow: ```xml { "attributes": { "type": record.attributes.objectType, "referenceId": record.attributes.referenceId }, "Name": record.Name, "Phone": record.Phone, "Website": record.Website, "NumberOfEmployees": record.NumberOfEmployees as Number, ("ChildAccounts": { "records": record.ChildAccounts.records map ((record01, indexOfRecord01) -> { "attributes": { "type": record01.attributes.objectType, "referenceId": record01.attributes.referenceId }, "Name": record01.Name, "Phone": record01.Phone, "Website": record01.Website, "NumberOfEmployees": record01.NumberOfEmployees as Number }) }), "Contacts": { "records": record.Contacts.records map ((record01, indexOfRecord01) -> { "attributes": { "type": record01.attributes.objectType, "referenceId": record01.attributes.referenceId }, "LastName": record01.LastName, "Email": record01.Email, "Title": record01.Title }) } }) ]]> ``` ## Pre-Query Example This example provides metadata for an object to query, generates two subrequests that contain this metadata, and then executes the subrequests: - HTTP **Listener** Accepts data from HTTP requests - **Transform Message** Specifies a name for the object - **Pre create** Provides metadata for the object to be created and generates a subrequest used in execution - **Transform Message** Specifies values for fields - **Pre query** Provides metadata for the object that is going to be queried and generates a subrequest used in execution - **Transform Message** Passes output from **Pre query** operation - **Execute composite batch** Sends all subrequests in one batch - **Transform Message** Outputs the results in JSON format ![Studio flow with an HTTP Listener component, Transform components, and multiple Salesfore Composite operations](/mulesoft/current/en-us/salesforce-composite-connector/2.19/_images/salesforce-composite-prequery-flow.png) ### Add an HTTP Listener The HTTP **Listener** source operation initiates the flow when it detects an event in the `executeFlow` path. To add the listener and trigger the flow, follow these steps: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 3. Drag the **Listener** operation onto the canvas. 4. In the Listener properties window, set the **Path** field to `/executeFlow`. ### Add the First Transform Message Component The first Transform Message component specifies a name for the created object and passes the name to the **Pre create** operation. To add the component, follow these steps: 1. In the **Mule Palette** view, search for **Transform Message**. 2. Drag **Transform Message** onto the canvas, to the right of **Listener**. 3. Enter the name `MyNewAccount`: ```dataweave %dw 2.0 %output application/java --- { Name: "MyNewAccount" } ``` ### Add the Pre Create Operation The Pre Create operation provides metadata for creating an object called `NewAccount` and generates a subrequest for the `executeCompositeBatch` operation. To add the operation, follow these steps: 1. In the **Mule Palette** view, search for `salesforce` and select the Salesforce Composite **Pre create** operation. 2. Drag the **Pre create** operation to the right of **Transform Message**. 3. Click the green plus icon (**+**) to the right of the **Connector configuration** field to access the Salesforce Composite global element configuration fields. 4. In the **Pre create** properties window, enter `Account` in the **Type** field. 5. In the properties file `src/main/mule/mule-app.properties`, declare and enter values for the variables in the global element. ![Salesforce Composite Connector global element configuration window](/mulesoft/current/en-us/salesforce-composite-connector/2.19/_images/salesforce-composite-global-config.png) ### Add the Second Transform Message Component The second Transform Message component specifies values for the **ID** and **Type** fields, and then passes these values to the **Pre query** operation. To add the component, follow these steps: 1. Drag a second **Transform Message** component to the right of **Pre create**. 2. Enter the following name-value pairs: ```dataweave %dw 2.0 %output application/java --- { "Id": payload.Id, "Fields" : ["Id", "Name"], "Type": "Account" } ``` ### Add the Pre Query Operation The Pre Query operation provides metadata for an object to be queried. It generates a subrequest for the **Execute composite batch** operation. To add the operation, follow these steps: 1. Drag a Salesforce Composite **Pre query** operation to the right of the second **Transform Message**. 2. In the **Query** field, enter the following: `Select Name from Account WHERE Name LIKE '%:name %'` ### Add the Third Transform Message Component The third Transform Message operation passes the output of the **Pre query** operation to the **Execute composite batch** operation. To add the component, follow these steps: 1. Drag a third **Transform Message** component to the right of **Pre query**. 2. Set the output to `payload`: ```dataweave %dw 2.0 %output application/java --- [ payload ] ``` ### Add the Execute Composite Batch Operation The Execute Composite Batch operation executes the subrequests that the Pre Create and Pre Query operations created. To add the operation, drag a Salesforce Composite **Execute composite batch** operation to the right of the third **Transform Message**. ### Add the Fourth Transform Message Component The fourth Transform Message operation converts the output to JSON format. To add the component, follow these steps: 1. Drag a fourth **Transform Message** component to the right of **Execute composite batch**. 2. Set the output to `application/json`: ```dataweave %dw 2.0 %output application/json --- payload ``` ### XML for the Pre-Query Example Paste this code into your XML editor to quickly load the flow for this example to your Mule app. If needed, change the values to reflect your environment. ```xml Select Name from Account WHERE Name LIKE '%:name %' ``` ## See Also - [Salesforce Composite Connector Reference](https://docs.mulesoft.com/salesforce-composite-connector/2.19/salesforce-composite-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.19 --- # Salesforce Composite Connector 2.19 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio. - If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/salesforce-composite http://www.mulesoft.org/schema/mule/salesforce-composite/current/mule-salesforce-composite.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule-salesforce-composite-connector x.x.x mule-plugin ``` Verify that the connector `version` corresponds to the one you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `salesforce composite`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/salesforce-composite-connector/2.19/salesforce-composite-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.19 --- # Salesforce Composite Connector 2.19 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Default Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

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 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Reconnection

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

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.

### OAuth JWT #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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.

### OAuth SAML #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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.

### Token Connection #### Parameters
NameTypeDescriptionDefault ValueRequired

Session Id

String

Session ID.

x

Instance Url

String

Instance URL.

x

TLS configuration

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

HTTP

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 Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Reconnection

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

## Operations - [Create Sobject Collections](#createSobjectCollections) - [Create sObject Tree](#createSobjectTree) - [Delete sObject Collections](#deleteSobjectCollections) - [Execute Composite Batch](#executeCompositeBatch) - [Execute Composite Graph](#executeCompositeGraph) - [Execute Composite Request](#executeCompositeRequest) - [Get sObject Collections](#getSobjectCollections) - [Post Create](#postCreate) - [Post Delete](#postDelete) - [Post Get Limits](#postGetLimits) - [Post Query](#postQuery) - [Post Query All](#postQueryAll) - [Post Retrieve](#postRetrieve) - [Post Search](#postSearch) - [Post Update](#postUpdate) - [Pre Create](#preCreate) - [Pre Delete](#preDelete) - [Pre Get Limits](#preGetLimits) - [Pre Query](#preQuery) - [Pre Query All](#preQueryAll) - [Pre Retrieve](#preRetrieve) - [Pre Search](#preSearch) - [Pre Update](#preUpdate) - [Unauthorize](#unauthorize) - [Update sObject Collections](#updateSobjectCollections) - [Upsert sObject Collections](#upsertSobjectCollections) ### 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Sends a list of sObject trees to Salesforce to be created. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Delete up to 200 records and return a list of `DeleteResult` objects. You can roll back the entire request if an error occurs. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Performs composite requests by executing a series of REST API requests in a single call. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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. > [!NOTE] You can add `httpHeaders` within `compositeRequest`, for example: > `"httpHeaders" : { "X-REQUEST-ID" : "ReferenceId" }`. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Retrieve one or more records of the same object type. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### Throws - SALESFORCE-COMPOSITE:CONNECTIVITY - SALESFORCE-COMPOSITE:INVALID\_SESSION - SALESFORCE-COMPOSITE:TRANSACTION - SALESFORCE-COMPOSITE:TRANSFORMATION - SALESFORCE-COMPOSITE:UNKNOWN - SALESFORCE-COMPOSITE:VALIDATION ### 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Query Result

Object

The result of the create subrequest.

#[payload]

Streaming Strategy

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### Throws - SALESFORCE-COMPOSITE:CONNECTIVITY - SALESFORCE-COMPOSITE:INVALID\_SESSION - SALESFORCE-COMPOSITE:TRANSACTION - SALESFORCE-COMPOSITE:TRANSFORMATION - SALESFORCE-COMPOSITE:UNKNOWN - SALESFORCE-COMPOSITE:VALIDATION ### 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Provide metadata for getLimits and generate a subrequest for execution by `executeCompositeBatch(String, java.util.List)`. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Provide the user a way to input a SOSL String and generate a subrequest for execution by `executeCompositeBatch(java.util.List)`. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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.

#[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.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The ID of the resource owner for whom to invalidate access

#### For Configurations - [Default Configuration](#composite-config) ### 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

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.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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
FieldTypeDescriptionDefault ValueRequired

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

Contains the configuration parameters for the trust store configuration

Key Store Configuration

Contains the configuration parameters for the key store configuration

Revocation Check

### Trust Store Configuration
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

### Reconnect Forever
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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.

## See Also [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.20 --- # Salesforce Composite Connector 2.20 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Composite enables you to work with the Salesforce Batch and SObject Tree APIs. The connector exposes convenient methods for preparing subordinate requests, executing them in one batch, and parsing the results. Salesforce Composite Connector also enables you to create SObject trees by using the **Create sobject tree** operation, which is separate from the batch operations. This connector provides DataSense for execution and to: - Prepare subordinate requests and then parse the responses - Create SObject trees For compatibility information and fixed issues, see Salesforce Composite Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce Composite API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Credentials to access the Salesforce Composite target resource - Anypoint Studio version 7.0 or later ## Authentication Types Salesforce Composite Connector connections use the following authentication types: - OAuth v2.0 - OAuth JWT - OAuth SAML - OAuth Username and Password - Token Connection For information about configuring these authentication types, see [Using Anypoint Studio to Configure Salesforce Composite Connector](https://docs.mulesoft.com/salesforce-composite-connector/2.20/salesforce-composite-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.20 --- # Salesforce Composite Connector 2.20 - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## SObject Tree Operation Example This example uses the following operations to create an SObject tree to connect to Salesforce and transform and output the results in JSON format: - HTTP **Listener** Accepts data from HTTP requests - **Transform Message** Transforms the HTTP input - **Create sobject tree** Connects with Salesforce and creates an SObject tree - **Transform Message** Outputs the results of the **Create sobject tree** operation in JSON format ![Studio flow with an HTTP Listener component, Transform components, and a Create operation](/mulesoft/current/en-us/salesforce-composite-connector/2.20/_images/salesforce-composite-studio-use-case.png) ### Add an HTTP Listener The HTTP **Listener** source operation initiates the flow when it detects an event in the `createSObjectTree` path. To add the listener and trigger the flow, follow these steps: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 3. Drag the **Listener** operation onto the canvas. 4. In the Listener properties window, set the **Path** field to `/createSObjectTree`. ### Add the First Transform Message Component The first Transform Message component uses input data to transform the HTTP input for the following Create operation. To add the component, follow these steps: 1. In the **Mule Palette** view, search for **Transform Message**. 2. Drag the **Transform Message** component onto the canvas, to the right of **Listener**. 3. Enter the name `Transform HTTP input for Create SObject Tree`. The following is an example of HTTP input for the Transform Message component: ```json { "records": [ { "ChildAccounts": { "records": [ { "Phone": "4321098765", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref5" }, "NumberOfEmployees": "10", "Name": "ChildAccount1" } ] }, "Contacts": { "records": [ { "Email": "sample@salesforce.com", "Title": "President", "attributes": { "objectType": "Contact", "referenceId": "ref6" }, "LastName": "Jones" } ] }, "Phone": "5556543210", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref4" }, "NumberOfEmployees": "101", "Name": "CreateSobjectTreeAccount2" }, { "Contacts": { "records": [ { "Email": "sample@salesforce.com", "Title": "President", "attributes": { "objectType": "Contact", "referenceId": "ref2" }, "LastName": "Smith" }, { "Email": "sample@salesforce.com", "Title": "Vice President", "attributes": { "objectType": "Contact", "referenceId": "ref3" }, "LastName": "Evans" } ] }, "Phone": "1234567890", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref1" }, "NumberOfEmployees": "100", "Name": "CreateSobjectTreeAccount1" } ] } ``` ### Add the Create SObject Tree Operation Add the Create SObject Tree operation to connect with Salesforce and create an SObject tree. To add the operation, follow these steps: 1. In the **Mule Palette** view, search for `salesforce` and select **Create sobject tree**. 2. Drag **Create sobject tree** operation to the right of **Transform Message**. 3. Click the green plus sign (**+**) to the right of **Connector configuration** to access the Salesforce Composite global element configuration fields. 4. In the **Create sobject tree** properties window, enter `Account` in the **SObject Root Type** field. 5. In the properties file `src/main/mule/mule-app.properties`, declare and enter values for the variables in the global element. ### Add the Second Transform Message Component The second Transform Message component transforms the output result into JSON. To add the component, follow these steps: 1. Drag **Transform Message** again to the right of **Create sobject tree**. 2. Enter the following: ```dataweave %dw 2.0 %output application/json payload --- { "Id": payload.Id, "Fields" : ["Id", "Name"], "Type": "Account" } ``` ### XML for the SObject Tree Operation Flow Paste this XML code into the **Configuration XML** tab of the Anypoint Studio canvas to experiment with the flow: ```xml { "attributes": { "type": record.attributes.objectType, "referenceId": record.attributes.referenceId }, "Name": record.Name, "Phone": record.Phone, "Website": record.Website, "NumberOfEmployees": record.NumberOfEmployees as Number, ("ChildAccounts": { "records": record.ChildAccounts.records map ((record01, indexOfRecord01) -> { "attributes": { "type": record01.attributes.objectType, "referenceId": record01.attributes.referenceId }, "Name": record01.Name, "Phone": record01.Phone, "Website": record01.Website, "NumberOfEmployees": record01.NumberOfEmployees as Number }) }), "Contacts": { "records": record.Contacts.records map ((record01, indexOfRecord01) -> { "attributes": { "type": record01.attributes.objectType, "referenceId": record01.attributes.referenceId }, "LastName": record01.LastName, "Email": record01.Email, "Title": record01.Title }) } }) ]]> ``` ## Pre-Query Example This example provides metadata for an object to query, generates two subrequests that contain this metadata, and then executes the subrequests: - HTTP **Listener** Accepts data from HTTP requests - **Transform Message** Specifies a name for the object - **Pre create** Provides metadata for the object to be created and generates a subrequest used in execution - **Transform Message** Specifies values for fields - **Pre query** Provides metadata for the object that is going to be queried and generates a subrequest used in execution - **Transform Message** Passes output from **Pre query** operation - **Execute composite batch** Sends all subrequests in one batch - **Transform Message** Outputs the results in JSON format ![Studio flow with an HTTP Listener component, Transform components, and multiple Salesfore Composite operations](/mulesoft/current/en-us/salesforce-composite-connector/2.20/_images/salesforce-composite-prequery-flow.png) ### Add an HTTP Listener The HTTP **Listener** source operation initiates the flow when it detects an event in the `executeFlow` path. To add the listener and trigger the flow, follow these steps: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 3. Drag the **Listener** operation onto the canvas. 4. In the Listener properties window, set the **Path** field to `/executeFlow`. ### Add the First Transform Message Component The first Transform Message component specifies a name for the created object and passes the name to the **Pre create** operation. To add the component, follow these steps: 1. In the **Mule Palette** view, search for **Transform Message**. 2. Drag **Transform Message** onto the canvas, to the right of **Listener**. 3. Enter the name `MyNewAccount`: ```dataweave %dw 2.0 %output application/java --- { Name: "MyNewAccount" } ``` ### Add the Pre Create Operation The Pre Create operation provides metadata for creating an object called `NewAccount` and generates a subrequest for the `executeCompositeBatch` operation. To add the operation, follow these steps: 1. In the **Mule Palette** view, search for `salesforce` and select the Salesforce Composite **Pre create** operation. 2. Drag the **Pre create** operation to the right of **Transform Message**. 3. Click the green plus icon (**+**) to the right of the **Connector configuration** field to access the Salesforce Composite global element configuration fields. 4. In the **Pre create** properties window, enter `Account` in the **Type** field. 5. In the properties file `src/main/mule/mule-app.properties`, declare and enter values for the variables in the global element. ![Salesforce Composite Connector global element configuration window](/mulesoft/current/en-us/salesforce-composite-connector/2.20/_images/salesforce-composite-global-config.png) ### Add the Second Transform Message Component The second Transform Message component specifies values for the **ID** and **Type** fields, and then passes these values to the **Pre query** operation. To add the component, follow these steps: 1. Drag a second **Transform Message** component to the right of **Pre create**. 2. Enter the following name-value pairs: ```dataweave %dw 2.0 %output application/java --- { "Id": payload.Id, "Fields" : ["Id", "Name"], "Type": "Account" } ``` ### Add the Pre Query Operation The Pre Query operation provides metadata for an object to be queried. It generates a subrequest for the **Execute composite batch** operation. To add the operation, follow these steps: 1. Drag a Salesforce Composite **Pre query** operation to the right of the second **Transform Message**. 2. In the **Query** field, enter the following: `Select Name from Account WHERE Name LIKE '%:name %'` ### Add the Third Transform Message Component The third Transform Message operation passes the output of the **Pre query** operation to the **Execute composite batch** operation. To add the component, follow these steps: 1. Drag a third **Transform Message** component to the right of **Pre query**. 2. Set the output to `payload`: ```dataweave %dw 2.0 %output application/java --- [ payload ] ``` ### Add the Execute Composite Batch Operation The Execute Composite Batch operation executes the subrequests that the Pre Create and Pre Query operations created. To add the operation, drag a Salesforce Composite **Execute composite batch** operation to the right of the third **Transform Message**. ### Add the Fourth Transform Message Component The fourth Transform Message operation converts the output to JSON format. To add the component, follow these steps: 1. Drag a fourth **Transform Message** component to the right of **Execute composite batch**. 2. Set the output to `application/json`: ```dataweave %dw 2.0 %output application/json --- payload ``` ### XML for the Pre-Query Example Paste this code into your XML editor to quickly load the flow for this example to your Mule app. If needed, change the values to reflect your environment. ```xml Select Name from Account WHERE Name LIKE '%:name %' ``` ## See Also - [Salesforce Composite Connector Reference](https://docs.mulesoft.com/salesforce-composite-connector/2.20/salesforce-composite-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.20 --- # Salesforce Composite Connector 2.20 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio. - If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/salesforce-composite http://www.mulesoft.org/schema/mule/salesforce-composite/current/mule-salesforce-composite.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule-salesforce-composite-connector x.x.x mule-plugin ``` Verify that the connector `version` corresponds to the one you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `salesforce composite`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/salesforce-composite-connector/2.20/salesforce-composite-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.20 --- # Salesforce Composite Connector 2.20 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Default Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

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 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Reconnection

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

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.

### OAuth JWT #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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.

### OAuth SAML #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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.

### Token Connection #### Parameters
NameTypeDescriptionDefault ValueRequired

Session Id

String

Session ID.

x

Instance Url

String

Instance URL.

x

TLS configuration

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

HTTP

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 Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Reconnection

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

## Operations - [Create Sobject Collections](#createSobjectCollections) - [Create sObject Tree](#createSobjectTree) - [Delete sObject Collections](#deleteSobjectCollections) - [Execute Composite Batch](#executeCompositeBatch) - [Execute Composite Graph](#executeCompositeGraph) - [Execute Composite Request](#executeCompositeRequest) - [Get sObject Collections](#getSobjectCollections) - [Post Create](#postCreate) - [Post Delete](#postDelete) - [Post Get Limits](#postGetLimits) - [Post Query](#postQuery) - [Post Query All](#postQueryAll) - [Post Retrieve](#postRetrieve) - [Post Search](#postSearch) - [Post Update](#postUpdate) - [Pre Create](#preCreate) - [Pre Delete](#preDelete) - [Pre Get Limits](#preGetLimits) - [Pre Query](#preQuery) - [Pre Query All](#preQueryAll) - [Pre Retrieve](#preRetrieve) - [Pre Search](#preSearch) - [Pre Update](#preUpdate) - [Unauthorize](#unauthorize) - [Update sObject Collections](#updateSobjectCollections) - [Upsert sObject Collections](#upsertSobjectCollections) ### 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Sends a list of sObject trees to Salesforce to be created. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Delete up to 200 records and return a list of `DeleteResult` objects. You can roll back the entire request if an error occurs. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Performs composite requests by executing a series of REST API requests in a single call. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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. > [!NOTE] You can add `httpHeaders` within `compositeRequest`, for example: > `"httpHeaders" : { "X-REQUEST-ID" : "ReferenceId" }`. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Retrieve one or more records of the same object type. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### Throws - SALESFORCE-COMPOSITE:CONNECTIVITY - SALESFORCE-COMPOSITE:INVALID\_SESSION - SALESFORCE-COMPOSITE:TRANSACTION - SALESFORCE-COMPOSITE:TRANSFORMATION - SALESFORCE-COMPOSITE:UNKNOWN - SALESFORCE-COMPOSITE:VALIDATION ### 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Query Result

Object

The result of the create subrequest.

#[payload]

Streaming Strategy

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### Throws - SALESFORCE-COMPOSITE:CONNECTIVITY - SALESFORCE-COMPOSITE:INVALID\_SESSION - SALESFORCE-COMPOSITE:TRANSACTION - SALESFORCE-COMPOSITE:TRANSFORMATION - SALESFORCE-COMPOSITE:UNKNOWN - SALESFORCE-COMPOSITE:VALIDATION ### 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Provide metadata for getLimits and generate a subrequest for execution by `executeCompositeBatch(String, java.util.List)`. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Provide the user a way to input a SOSL String and generate a subrequest for execution by `executeCompositeBatch(java.util.List)`. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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.

#[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.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The ID of the resource owner for whom to invalidate access

#### For Configurations - [Default Configuration](#composite-config) ### 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

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.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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
FieldTypeDescriptionDefault ValueRequired

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

Contains the configuration parameters for the trust store configuration

Key Store Configuration

Contains the configuration parameters for the key store configuration

Revocation Check

### Trust Store Configuration
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

### Reconnect Forever
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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.

## See Also [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.21 --- # Salesforce Composite Connector 2.21 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Composite enables you to work with the Salesforce Batch and SObject Tree APIs. The connector exposes convenient methods for preparing subordinate requests, executing them in one batch, and parsing the results. Salesforce Composite Connector also enables you to create SObject trees by using the **Create sobject tree** operation, which is separate from the batch operations. This connector provides DataSense for execution and to: - Prepare subordinate requests and then parse the responses - Create SObject trees For compatibility information and fixed issues, see Salesforce Composite Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce Composite API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Credentials to access the Salesforce Composite target resource - Anypoint Studio version 7.0 or later ## Authentication Types Salesforce Composite Connector connections use the following authentication types: - OAuth v2.0 - OAuth JWT - OAuth SAML - OAuth Username and Password - Token Connection For information about configuring these authentication types, see [Using Anypoint Studio to Configure Salesforce Composite Connector](https://docs.mulesoft.com/salesforce-composite-connector/2.21/salesforce-composite-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.21 --- # Salesforce Composite Connector 2.21 - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## SObject Tree Operation Example This example uses the following operations to create an SObject tree to connect to Salesforce and transform and output the results in JSON format: - HTTP **Listener** Accepts data from HTTP requests - **Transform Message** Transforms the HTTP input - **Create sobject tree** Connects with Salesforce and creates an SObject tree - **Transform Message** Outputs the results of the **Create sobject tree** operation in JSON format ![Studio flow with an HTTP Listener component, Transform components, and a Create operation](/mulesoft/current/en-us/salesforce-composite-connector/2.21/_images/salesforce-composite-studio-use-case.png) ### Add an HTTP Listener The HTTP **Listener** source operation initiates the flow when it detects an event in the `createSObjectTree` path. To add the listener and trigger the flow, follow these steps: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 3. Drag the **Listener** operation onto the canvas. 4. In the Listener properties window, set the **Path** field to `/createSObjectTree`. ### Add the First Transform Message Component The first Transform Message component uses input data to transform the HTTP input for the following Create operation. To add the component, follow these steps: 1. In the **Mule Palette** view, search for **Transform Message**. 2. Drag the **Transform Message** component onto the canvas, to the right of **Listener**. 3. Enter the name `Transform HTTP input for Create SObject Tree`. The following is an example of HTTP input for the Transform Message component: ```json { "records": [ { "ChildAccounts": { "records": [ { "Phone": "4321098765", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref5" }, "NumberOfEmployees": "10", "Name": "ChildAccount1" } ] }, "Contacts": { "records": [ { "Email": "sample@salesforce.com", "Title": "President", "attributes": { "objectType": "Contact", "referenceId": "ref6" }, "LastName": "Jones" } ] }, "Phone": "5556543210", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref4" }, "NumberOfEmployees": "101", "Name": "CreateSobjectTreeAccount2" }, { "Contacts": { "records": [ { "Email": "sample@salesforce.com", "Title": "President", "attributes": { "objectType": "Contact", "referenceId": "ref2" }, "LastName": "Smith" }, { "Email": "sample@salesforce.com", "Title": "Vice President", "attributes": { "objectType": "Contact", "referenceId": "ref3" }, "LastName": "Evans" } ] }, "Phone": "1234567890", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref1" }, "NumberOfEmployees": "100", "Name": "CreateSobjectTreeAccount1" } ] } ``` ### Add the Create SObject Tree Operation Add the Create SObject Tree operation to connect with Salesforce and create an SObject tree. To add the operation, follow these steps: 1. In the **Mule Palette** view, search for `salesforce` and select **Create sobject tree**. 2. Drag **Create sobject tree** operation to the right of **Transform Message**. 3. Click the green plus sign (**+**) to the right of **Connector configuration** to access the Salesforce Composite global element configuration fields. 4. In the **Create sobject tree** properties window, enter `Account` in the **SObject Root Type** field. 5. In the properties file `src/main/mule/mule-app.properties`, declare and enter values for the variables in the global element. ### Add the Second Transform Message Component The second Transform Message component transforms the output result into JSON. To add the component, follow these steps: 1. Drag **Transform Message** again to the right of **Create sobject tree**. 2. Enter the following: ```dataweave %dw 2.0 %output application/json payload --- { "Id": payload.Id, "Fields" : ["Id", "Name"], "Type": "Account" } ``` ### XML for the SObject Tree Operation Flow Paste this XML code into the **Configuration XML** tab of the Anypoint Studio canvas to experiment with the flow: ```xml { "attributes": { "type": record.attributes.objectType, "referenceId": record.attributes.referenceId }, "Name": record.Name, "Phone": record.Phone, "Website": record.Website, "NumberOfEmployees": record.NumberOfEmployees as Number, ("ChildAccounts": { "records": record.ChildAccounts.records map ((record01, indexOfRecord01) -> { "attributes": { "type": record01.attributes.objectType, "referenceId": record01.attributes.referenceId }, "Name": record01.Name, "Phone": record01.Phone, "Website": record01.Website, "NumberOfEmployees": record01.NumberOfEmployees as Number }) }), "Contacts": { "records": record.Contacts.records map ((record01, indexOfRecord01) -> { "attributes": { "type": record01.attributes.objectType, "referenceId": record01.attributes.referenceId }, "LastName": record01.LastName, "Email": record01.Email, "Title": record01.Title }) } }) ]]> ``` ## Pre-Query Example This example provides metadata for an object to query, generates two subrequests that contain this metadata, and then executes the subrequests: - HTTP **Listener** Accepts data from HTTP requests - **Transform Message** Specifies a name for the object - **Pre create** Provides metadata for the object to be created and generates a subrequest used in execution - **Transform Message** Specifies values for fields - **Pre query** Provides metadata for the object that is going to be queried and generates a subrequest used in execution - **Transform Message** Passes output from **Pre query** operation - **Execute composite batch** Sends all subrequests in one batch - **Transform Message** Outputs the results in JSON format ![Studio flow with an HTTP Listener component, Transform components, and multiple Salesfore Composite operations](/mulesoft/current/en-us/salesforce-composite-connector/2.21/_images/salesforce-composite-prequery-flow.png) ### Add an HTTP Listener The HTTP **Listener** source operation initiates the flow when it detects an event in the `executeFlow` path. To add the listener and trigger the flow, follow these steps: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 3. Drag the **Listener** operation onto the canvas. 4. In the Listener properties window, set the **Path** field to `/executeFlow`. ### Add the First Transform Message Component The first Transform Message component specifies a name for the created object and passes the name to the **Pre create** operation. To add the component, follow these steps: 1. In the **Mule Palette** view, search for **Transform Message**. 2. Drag **Transform Message** onto the canvas, to the right of **Listener**. 3. Enter the name `MyNewAccount`: ```dataweave %dw 2.0 %output application/java --- { Name: "MyNewAccount" } ``` ### Add the Pre Create Operation The Pre Create operation provides metadata for creating an object called `NewAccount` and generates a subrequest for the `executeCompositeBatch` operation. To add the operation, follow these steps: 1. In the **Mule Palette** view, search for `salesforce` and select the Salesforce Composite **Pre create** operation. 2. Drag the **Pre create** operation to the right of **Transform Message**. 3. Click the green plus icon (**+**) to the right of the **Connector configuration** field to access the Salesforce Composite global element configuration fields. 4. In the **Pre create** properties window, enter `Account` in the **Type** field. 5. In the properties file `src/main/mule/mule-app.properties`, declare and enter values for the variables in the global element. ![Salesforce Composite Connector global element configuration window](/mulesoft/current/en-us/salesforce-composite-connector/2.21/_images/salesforce-composite-global-config.png) ### Add the Second Transform Message Component The second Transform Message component specifies values for the **ID** and **Type** fields, and then passes these values to the **Pre query** operation. To add the component, follow these steps: 1. Drag a second **Transform Message** component to the right of **Pre create**. 2. Enter the following name-value pairs: ```dataweave %dw 2.0 %output application/java --- { "Id": payload.Id, "Fields" : ["Id", "Name"], "Type": "Account" } ``` ### Add the Pre Query Operation The Pre Query operation provides metadata for an object to be queried. It generates a subrequest for the **Execute composite batch** operation. To add the operation, follow these steps: 1. Drag a Salesforce Composite **Pre query** operation to the right of the second **Transform Message**. 2. In the **Query** field, enter the following: `Select Name from Account WHERE Name LIKE '%:name %'` ### Add the Third Transform Message Component The third Transform Message operation passes the output of the **Pre query** operation to the **Execute composite batch** operation. To add the component, follow these steps: 1. Drag a third **Transform Message** component to the right of **Pre query**. 2. Set the output to `payload`: ```dataweave %dw 2.0 %output application/java --- [ payload ] ``` ### Add the Execute Composite Batch Operation The Execute Composite Batch operation executes the subrequests that the Pre Create and Pre Query operations created. To add the operation, drag a Salesforce Composite **Execute composite batch** operation to the right of the third **Transform Message**. ### Add the Fourth Transform Message Component The fourth Transform Message operation converts the output to JSON format. To add the component, follow these steps: 1. Drag a fourth **Transform Message** component to the right of **Execute composite batch**. 2. Set the output to `application/json`: ```dataweave %dw 2.0 %output application/json --- payload ``` ### XML for the Pre-Query Example Paste this code into your XML editor to quickly load the flow for this example to your Mule app. If needed, change the values to reflect your environment. ```xml Select Name from Account WHERE Name LIKE '%:name %' ``` ## See Also - [Salesforce Composite Connector Reference](https://docs.mulesoft.com/salesforce-composite-connector/2.21/salesforce-composite-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.21 --- # Salesforce Composite Connector 2.21 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio. - If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/salesforce-composite http://www.mulesoft.org/schema/mule/salesforce-composite/current/mule-salesforce-composite.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule-salesforce-composite-connector x.x.x mule-plugin ``` Verify that the connector `version` corresponds to the one you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `salesforce composite`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/salesforce-composite-connector/2.21/salesforce-composite-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.21 --- # Salesforce Composite Connector 2.21 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Default Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

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 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Reconnection

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

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.

### OAuth JWT #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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.

### OAuth SAML #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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.

### Token Connection #### Parameters
NameTypeDescriptionDefault ValueRequired

Session Id

String

Session ID.

x

Instance Url

String

Instance URL.

x

TLS configuration

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

HTTP

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 Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Reconnection

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

## Operations - [Create Sobject Collections](#createSobjectCollections) - [Create sObject Tree](#createSobjectTree) - [Delete sObject Collections](#deleteSobjectCollections) - [Execute Composite Batch](#executeCompositeBatch) - [Execute Composite Graph](#executeCompositeGraph) - [Execute Composite Request](#executeCompositeRequest) - [Get sObject Collections](#getSobjectCollections) - [Post Create](#postCreate) - [Post Delete](#postDelete) - [Post Get Limits](#postGetLimits) - [Post Query](#postQuery) - [Post Query All](#postQueryAll) - [Post Retrieve](#postRetrieve) - [Post Search](#postSearch) - [Post Update](#postUpdate) - [Pre Create](#preCreate) - [Pre Delete](#preDelete) - [Pre Get Limits](#preGetLimits) - [Pre Query](#preQuery) - [Pre Query All](#preQueryAll) - [Pre Retrieve](#preRetrieve) - [Pre Search](#preSearch) - [Pre Update](#preUpdate) - [Unauthorize](#unauthorize) - [Update sObject Collections](#updateSobjectCollections) - [Upsert sObject Collections](#upsertSobjectCollections) ### 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Sends a list of sObject trees to Salesforce to be created. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Delete up to 200 records and return a list of `DeleteResult` objects. You can roll back the entire request if an error occurs. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Performs composite requests by executing a series of REST API requests in a single call. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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. > [!NOTE] You can add `httpHeaders` within `compositeRequest`, for example: > `"httpHeaders" : { "X-REQUEST-ID" : "ReferenceId" }`. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Retrieve one or more records of the same object type. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### Throws - SALESFORCE-COMPOSITE:CONNECTIVITY - SALESFORCE-COMPOSITE:INVALID\_SESSION - SALESFORCE-COMPOSITE:TRANSACTION - SALESFORCE-COMPOSITE:TRANSFORMATION - SALESFORCE-COMPOSITE:UNKNOWN - SALESFORCE-COMPOSITE:VALIDATION ### 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Query Result

Object

The result of the create subrequest.

#[payload]

Streaming Strategy

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### Throws - SALESFORCE-COMPOSITE:CONNECTIVITY - SALESFORCE-COMPOSITE:INVALID\_SESSION - SALESFORCE-COMPOSITE:TRANSACTION - SALESFORCE-COMPOSITE:TRANSFORMATION - SALESFORCE-COMPOSITE:UNKNOWN - SALESFORCE-COMPOSITE:VALIDATION ### 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Provide metadata for getLimits and generate a subrequest for execution by `executeCompositeBatch(String, java.util.List)`. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Provide the user a way to input a SOSL String and generate a subrequest for execution by `executeCompositeBatch(java.util.List)`. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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.

#[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.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The ID of the resource owner for whom to invalidate access

#### For Configurations - [Default Configuration](#composite-config) ### 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
NameTypeDescriptionDefault ValueRequired

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

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

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.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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
FieldTypeDescriptionDefault ValueRequired

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

Contains the configuration parameters for the trust store configuration

Key Store Configuration

Contains the configuration parameters for the key store configuration

Revocation Check

### Trust Store Configuration
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

### Reconnect Forever
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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.

## See Also [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.0 --- # Salesforce Composite Connector 3.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Composite enables you to work with the Salesforce Batch and SObject Tree APIs. The connector exposes convenient methods for preparing subordinate requests, executing them in one batch, and parsing the results. Salesforce Composite Connector also enables you to create SObject trees by using the **Create sobject tree** operation, which is separate from the batch operations. This connector provides DataSense for execution and to: - Prepare subordinate requests and then parse the responses - Create SObject trees For compatibility information and fixed issues, see Salesforce Composite Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce Composite API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Credentials to access the Salesforce Composite target resource - Anypoint Studio version 7.0 or later ## Authentication Types Salesforce Composite Connector connections use the following authentication types: - OAuth v2.0 - OAuth Client Credentials - OAuth JWT - OAuth SAML - OAuth Username and Password - Token Connection For information about configuring these authentication types, see [Using Anypoint Studio to Configure Salesforce Composite Connector](https://docs.mulesoft.com/salesforce-composite-connector/3.0/salesforce-composite-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.0 --- # Salesforce Composite Connector 3.0 - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## SObject Tree Operation Example This example uses the following operations to create an SObject tree to connect to Salesforce and transform and output the results in JSON format: - HTTP **Listener** Accepts data from HTTP requests - **Transform Message** Transforms the HTTP input - **Create sobject tree** Connects with Salesforce and creates an SObject tree - **Transform Message** Outputs the results of the **Create sobject tree** operation in JSON format ![Studio flow with an HTTP Listener component, Transform components, and a Create operation](/mulesoft/current/en-us/salesforce-composite-connector/3.0/_images/salesforce-composite-studio-use-case.png) ### Add an HTTP Listener The HTTP **Listener** source operation initiates the flow when it detects an event in the `createSObjectTree` path. To add the listener and trigger the flow, follow these steps: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 3. Drag the **Listener** operation onto the canvas. 4. In the Listener properties window, set the **Path** field to `/createSObjectTree`. ### Add the First Transform Message Component The first Transform Message component uses input data to transform the HTTP input for the following Create operation. To add the component, follow these steps: 1. In the **Mule Palette** view, search for **Transform Message**. 2. Drag the **Transform Message** component onto the canvas, to the right of **Listener**. 3. Enter the name `Transform HTTP input for Create SObject Tree`. The following is an example of HTTP input for the Transform Message component: ```json { "records": [ { "ChildAccounts": { "records": [ { "Phone": "4321098765", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref5" }, "NumberOfEmployees": "10", "Name": "ChildAccount1" } ] }, "Contacts": { "records": [ { "Email": "sample@salesforce.com", "Title": "President", "attributes": { "objectType": "Contact", "referenceId": "ref6" }, "LastName": "Jones" } ] }, "Phone": "5556543210", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref4" }, "NumberOfEmployees": "101", "Name": "CreateSobjectTreeAccount2" }, { "Contacts": { "records": [ { "Email": "sample@salesforce.com", "Title": "President", "attributes": { "objectType": "Contact", "referenceId": "ref2" }, "LastName": "Smith" }, { "Email": "sample@salesforce.com", "Title": "Vice President", "attributes": { "objectType": "Contact", "referenceId": "ref3" }, "LastName": "Evans" } ] }, "Phone": "1234567890", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref1" }, "NumberOfEmployees": "100", "Name": "CreateSobjectTreeAccount1" } ] } ``` ### Add the Create SObject Tree Operation Add the Create SObject Tree operation to connect with Salesforce and create an SObject tree. To add the operation, follow these steps: 1. In the **Mule Palette** view, search for `salesforce` and select **Create sobject tree**. 2. Drag **Create sobject tree** operation to the right of **Transform Message**. 3. Click the green plus sign (**+**) to the right of **Connector configuration** to access the Salesforce Composite global element configuration fields. 4. In the **Create sobject tree** properties window, enter `Account` in the **SObject Root Type** field. 5. In the properties file `src/main/mule/mule-app.properties`, declare and enter values for the variables in the global element. ### Add the Second Transform Message Component The second Transform Message component transforms the output result into JSON. To add the component, follow these steps: 1. Drag **Transform Message** again to the right of **Create sobject tree**. 2. Enter the following: ```dataweave %dw 2.0 %output application/json payload --- { "Id": payload.Id, "Fields" : ["Id", "Name"], "Type": "Account" } ``` ### XML for the SObject Tree Operation Flow Paste this XML code into the **Configuration XML** tab of the Anypoint Studio canvas to experiment with the flow: ```xml { "attributes": { "type": record.attributes.objectType, "referenceId": record.attributes.referenceId }, "Name": record.Name, "Phone": record.Phone, "Website": record.Website, "NumberOfEmployees": record.NumberOfEmployees as Number, ("ChildAccounts": { "records": record.ChildAccounts.records map ((record01, indexOfRecord01) -> { "attributes": { "type": record01.attributes.objectType, "referenceId": record01.attributes.referenceId }, "Name": record01.Name, "Phone": record01.Phone, "Website": record01.Website, "NumberOfEmployees": record01.NumberOfEmployees as Number }) }), "Contacts": { "records": record.Contacts.records map ((record01, indexOfRecord01) -> { "attributes": { "type": record01.attributes.objectType, "referenceId": record01.attributes.referenceId }, "LastName": record01.LastName, "Email": record01.Email, "Title": record01.Title }) } }) ]]> ``` ## Pre-Query Example This example provides metadata for an object to query, generates two subrequests that contain this metadata, and then executes the subrequests: - HTTP **Listener** Accepts data from HTTP requests - **Transform Message** Specifies a name for the object - **Pre create** Provides metadata for the object to be created and generates a subrequest used in execution - **Transform Message** Specifies values for fields - **Pre query** Provides metadata for the object that is going to be queried and generates a subrequest used in execution - **Transform Message** Passes output from **Pre query** operation - **Execute composite batch** Sends all subrequests in one batch - **Transform Message** Outputs the results in JSON format ![Studio flow with an HTTP Listener component, Transform components, and multiple Salesfore Composite operations](/mulesoft/current/en-us/salesforce-composite-connector/3.0/_images/salesforce-composite-prequery-flow.png) ### Add an HTTP Listener The HTTP **Listener** source operation initiates the flow when it detects an event in the `executeFlow` path. To add the listener and trigger the flow, follow these steps: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 3. Drag the **Listener** operation onto the canvas. 4. In the Listener properties window, set the **Path** field to `/executeFlow`. ### Add the First Transform Message Component The first Transform Message component specifies a name for the created object and passes the name to the **Pre create** operation. To add the component, follow these steps: 1. In the **Mule Palette** view, search for **Transform Message**. 2. Drag **Transform Message** onto the canvas, to the right of **Listener**. 3. Enter the name `MyNewAccount`: ```dataweave %dw 2.0 %output application/java --- { Name: "MyNewAccount" } ``` ### Add the Pre Create Operation The Pre Create operation provides metadata for creating an object called `NewAccount` and generates a subrequest for the `executeCompositeBatch` operation. To add the operation, follow these steps: 1. In the **Mule Palette** view, search for `salesforce` and select the Salesforce Composite **Pre create** operation. 2. Drag the **Pre create** operation to the right of **Transform Message**. 3. Click the green plus icon (**+**) to the right of the **Connector configuration** field to access the Salesforce Composite global element configuration fields. 4. In the **Pre create** properties window, enter `Account` in the **Type** field. 5. In the properties file `src/main/mule/mule-app.properties`, declare and enter values for the variables in the global element. ![Salesforce Composite Connector global element configuration window](/mulesoft/current/en-us/salesforce-composite-connector/3.0/_images/salesforce-composite-global-config.png) ### Add the Second Transform Message Component The second Transform Message component specifies values for the **ID** and **Type** fields, and then passes these values to the **Pre query** operation. To add the component, follow these steps: 1. Drag a second **Transform Message** component to the right of **Pre create**. 2. Enter the following name-value pairs: ```dataweave %dw 2.0 %output application/java --- { "Id": payload.Id, "Fields" : ["Id", "Name"], "Type": "Account" } ``` ### Add the Pre Query Operation The Pre Query operation provides metadata for an object to be queried. It generates a subrequest for the **Execute composite batch** operation. To add the operation, follow these steps: 1. Drag a Salesforce Composite **Pre query** operation to the right of the second **Transform Message**. 2. In the **Query** field, enter the following: `Select Name from Account WHERE Name LIKE '%:name %'` ### Add the Third Transform Message Component The third Transform Message operation passes the output of the **Pre query** operation to the **Execute composite batch** operation. To add the component, follow these steps: 1. Drag a third **Transform Message** component to the right of **Pre query**. 2. Set the output to `payload`: ```dataweave %dw 2.0 %output application/java --- [ payload ] ``` ### Add the Execute Composite Batch Operation The Execute Composite Batch operation executes the subrequests that the Pre Create and Pre Query operations created. To add the operation, drag a Salesforce Composite **Execute composite batch** operation to the right of the third **Transform Message**. ### Add the Fourth Transform Message Component The fourth Transform Message operation converts the output to JSON format. To add the component, follow these steps: 1. Drag a fourth **Transform Message** component to the right of **Execute composite batch**. 2. Set the output to `application/json`: ```dataweave %dw 2.0 %output application/json --- payload ``` ### XML for the Pre-Query Example Paste this code into your XML editor to quickly load the flow for this example to your Mule app. If needed, change the values to reflect your environment. ```xml Select Name from Account WHERE Name LIKE '%:name %' ``` ## See Also - [Salesforce Composite Connector Reference](https://docs.mulesoft.com/salesforce-composite-connector/3.0/salesforce-composite-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.0 --- # Salesforce Composite Connector 3.0 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio. - If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/salesforce-composite http://www.mulesoft.org/schema/mule/salesforce-composite/current/mule-salesforce-composite.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule-salesforce-composite-connector x.x.x mule-plugin ``` Verify that the connector `version` corresponds to the one you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `salesforce composite`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/salesforce-composite-connector/3.0/salesforce-composite-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.0 --- # Salesforce Composite Connector 3.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Default Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

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 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Reconnection

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

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.

### OAuth Client Credentials #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Reconnection

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

Client Id

String

The OAuth client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret as registered with the service provider.

x

Token Url

String

The service provider’s token 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.

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
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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.

### OAuth SAML #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time 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

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.

### Token Connection #### Parameters
NameTypeDescriptionDefault ValueRequired

Session Id

String

Session ID.

x

Instance Url

String

Instance URL.

x

TLS configuration

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

HTTP

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 Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Reconnection

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

## Operations - [Create Sobject Collections](#createSobjectCollections) - [Create sObject Tree](#createSobjectTree) - [Delete sObject Collections](#deleteSobjectCollections) - [Execute Composite Batch](#executeCompositeBatch) - [Execute Composite Graph](#executeCompositeGraph) - [Execute Composite Request](#executeCompositeRequest) - [Get sObject Collections](#getSobjectCollections) - [Post Create](#postCreate) - [Post Delete](#postDelete) - [Post Get Limits](#postGetLimits) - [Post Query](#postQuery) - [Post Query All](#postQueryAll) - [Post Retrieve](#postRetrieve) - [Post Search](#postSearch) - [Post Update](#postUpdate) - [Pre Create](#preCreate) - [Pre Delete](#preDelete) - [Pre Get Limits](#preGetLimits) - [Pre Query](#preQuery) - [Pre Query All](#preQueryAll) - [Pre Retrieve](#preRetrieve) - [Pre Search](#preSearch) - [Pre Update](#preUpdate) - [Unauthorize](#unauthorize) - [Update sObject Collections](#updateSobjectCollections) - [Upsert sObject Collections](#upsertSobjectCollections) ### 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Request Body

Object

The request body.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Sends a list of sObject trees to Salesforce to be created. #### Parameters
NameTypeDescriptionDefault ValueRequired

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]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Delete up to 200 records and return a list of `DeleteResult` objects. You can roll back the entire request if an error occurs. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Sub Requests

Array of Object

The list of subrequests to execute.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Performs composite requests by executing a series of REST API requests in a single call. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use

x

Graphs

Array of Object

List of graphs to execute

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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. > [!NOTE] You can add `httpHeaders` within `compositeRequest`, for example: > `"httpHeaders" : { "X-REQUEST-ID" : "ReferenceId" }`. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use

x

Request Body

Object

Request body

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Retrieve one or more records of the same object type. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Create Result

Object

The result of the create subrequest.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Delete Result

Object

The result of the delete subrequest.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Get Limits Result

Object

The result of the create subrequest.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

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

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Query Result

Object

The result of the create subrequest.

#[payload]

Streaming Strategy

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

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 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
NameTypeDescriptionDefault ValueRequired

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]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Search Result

Object

The result of the search subrequest.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Update Result

Object

The result of the update subrequest.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Provide metadata for getLimits and generate a subrequest for execution by `executeCompositeBatch(String, java.util.List)`. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Provide the user a way to input a SOSL String and generate a subrequest for execution by `executeCompositeBatch(java.util.List)`. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Search

String

The SOSL string that is run in executeCompositeBatch.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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.

#[payload].

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The ID of the resource owner for whom to invalidate access

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

#### For Configurations - [Default Configuration](#composite-config) ### 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Request Body

Object

The request body.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 Configures TLS to provide secure communications for the Mule app.
FieldTypeDescriptionDefault ValueRequired

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

Contains the configuration parameters for the trust store configuration

Key Store Configuration

Contains the configuration parameters for the key store configuration

Revocation Check

### Trust Store Configuration Configures the truststore for TLS.
FieldTypeDescriptionDefault ValueRequired

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 Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
FieldTypeDescriptionDefault ValueRequired

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 Configures standard revocation checks for TLS certificates.
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer CRLs

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the Prefer CRLs field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

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

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.
FieldTypeDescriptionDefault ValueRequired

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 Specifies the location of the certification revocation list (CRL) file.
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection Configures a reconnection strategy for an operation.
FieldTypeDescriptionDefault ValueRequired

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 Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to reconnect (in milliseconds).

Blocking

Boolean

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

Count

Number

The number of reconnection attempts to make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

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

### Expiration Policy Configures an expiration policy strategy.
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

In Memory Objects

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

Unit for the In Memory Objects field.

### Error Mapping
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

## See Also [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.1 is-latest-version: true --- # Salesforce Composite Connector 3.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Salesforce Composite enables you to work with the Salesforce Batch and SObject Tree APIs. The connector exposes convenient methods for preparing subordinate requests, executing them in one batch, and parsing the results. Salesforce Composite Connector also enables you to create SObject trees by using the **Create sobject tree** operation, which is separate from the batch operations. This connector provides DataSense for execution and to: - Prepare subordinate requests and then parse the responses - Create SObject trees For compatibility information and fixed issues, see Salesforce Composite Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Salesforce Composite API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Credentials to access the Salesforce Composite target resource - Anypoint Studio version 7.0 or later ## Authentication Types Salesforce Composite Connector connections use the following authentication types: - OAuth v2.0 - OAuth Client Credentials - OAuth JWT - OAuth SAML - OAuth Username and Password - Token Connection For information about configuring these authentication types, see [Using Anypoint Studio to Configure Salesforce Composite Connector](https://docs.mulesoft.com/salesforce-composite-connector/latest/salesforce-composite-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.1 is-latest-version: true --- # Salesforce Composite Connector 3.1 - Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## SObject Tree Operation Example This example uses the following operations to create an SObject tree to connect to Salesforce and transform and output the results in JSON format: - HTTP **Listener** Accepts data from HTTP requests - **Transform Message** Transforms the HTTP input - **Create sobject tree** Connects with Salesforce and creates an SObject tree - **Transform Message** Outputs the results of the **Create sobject tree** operation in JSON format ![Studio flow with an HTTP Listener component, Transform components, and a Create operation](/mulesoft/current/en-us/salesforce-composite-connector/latest/_images/salesforce-composite-studio-use-case.png) ### Add an HTTP Listener The HTTP **Listener** source operation initiates the flow when it detects an event in the `createSObjectTree` path. To add the listener and trigger the flow, follow these steps: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 3. Drag the **Listener** operation onto the canvas. 4. In the Listener properties window, set the **Path** field to `/createSObjectTree`. ### Add the First Transform Message Component The first Transform Message component uses input data to transform the HTTP input for the following Create operation. To add the component, follow these steps: 1. In the **Mule Palette** view, search for **Transform Message**. 2. Drag the **Transform Message** component onto the canvas, to the right of **Listener**. 3. Enter the name `Transform HTTP input for Create SObject Tree`. The following is an example of HTTP input for the Transform Message component: ```json { "records": [ { "ChildAccounts": { "records": [ { "Phone": "4321098765", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref5" }, "NumberOfEmployees": "10", "Name": "ChildAccount1" } ] }, "Contacts": { "records": [ { "Email": "sample@salesforce.com", "Title": "President", "attributes": { "objectType": "Contact", "referenceId": "ref6" }, "LastName": "Jones" } ] }, "Phone": "5556543210", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref4" }, "NumberOfEmployees": "101", "Name": "CreateSobjectTreeAccount2" }, { "Contacts": { "records": [ { "Email": "sample@salesforce.com", "Title": "President", "attributes": { "objectType": "Contact", "referenceId": "ref2" }, "LastName": "Smith" }, { "Email": "sample@salesforce.com", "Title": "Vice President", "attributes": { "objectType": "Contact", "referenceId": "ref3" }, "LastName": "Evans" } ] }, "Phone": "1234567890", "Website": "www.salesforce.com", "attributes": { "objectType": "Account", "referenceId": "ref1" }, "NumberOfEmployees": "100", "Name": "CreateSobjectTreeAccount1" } ] } ``` ### Add the Create SObject Tree Operation Add the Create SObject Tree operation to connect with Salesforce and create an SObject tree. To add the operation, follow these steps: 1. In the **Mule Palette** view, search for `salesforce` and select **Create sobject tree**. 2. Drag **Create sobject tree** operation to the right of **Transform Message**. 3. Click the green plus sign (**+**) to the right of **Connector configuration** to access the Salesforce Composite global element configuration fields. 4. In the **Create sobject tree** properties window, enter `Account` in the **SObject Root Type** field. 5. In the properties file `src/main/mule/mule-app.properties`, declare and enter values for the variables in the global element. ### Add the Second Transform Message Component The second Transform Message component transforms the output result into JSON. To add the component, follow these steps: 1. Drag **Transform Message** again to the right of **Create sobject tree**. 2. Enter the following: ```dataweave %dw 2.0 %output application/json payload --- { "Id": payload.Id, "Fields" : ["Id", "Name"], "Type": "Account" } ``` ### XML for the SObject Tree Operation Flow Paste this XML code into the **Configuration XML** tab of the Anypoint Studio canvas to experiment with the flow: ```xml { "attributes": { "type": record.attributes.objectType, "referenceId": record.attributes.referenceId }, "Name": record.Name, "Phone": record.Phone, "Website": record.Website, "NumberOfEmployees": record.NumberOfEmployees as Number, ("ChildAccounts": { "records": record.ChildAccounts.records map ((record01, indexOfRecord01) -> { "attributes": { "type": record01.attributes.objectType, "referenceId": record01.attributes.referenceId }, "Name": record01.Name, "Phone": record01.Phone, "Website": record01.Website, "NumberOfEmployees": record01.NumberOfEmployees as Number }) }), "Contacts": { "records": record.Contacts.records map ((record01, indexOfRecord01) -> { "attributes": { "type": record01.attributes.objectType, "referenceId": record01.attributes.referenceId }, "LastName": record01.LastName, "Email": record01.Email, "Title": record01.Title }) } }) ]]> ``` ## Pre-Query Example This example provides metadata for an object to query, generates two subrequests that contain this metadata, and then executes the subrequests: - HTTP **Listener** Accepts data from HTTP requests - **Transform Message** Specifies a name for the object - **Pre create** Provides metadata for the object to be created and generates a subrequest used in execution - **Transform Message** Specifies values for fields - **Pre query** Provides metadata for the object that is going to be queried and generates a subrequest used in execution - **Transform Message** Passes output from **Pre query** operation - **Execute composite batch** Sends all subrequests in one batch - **Transform Message** Outputs the results in JSON format ![Studio flow with an HTTP Listener component, Transform components, and multiple Salesfore Composite operations](/mulesoft/current/en-us/salesforce-composite-connector/latest/_images/salesforce-composite-prequery-flow.png) ### Add an HTTP Listener The HTTP **Listener** source operation initiates the flow when it detects an event in the `executeFlow` path. To add the listener and trigger the flow, follow these steps: 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 3. Drag the **Listener** operation onto the canvas. 4. In the Listener properties window, set the **Path** field to `/executeFlow`. ### Add the First Transform Message Component The first Transform Message component specifies a name for the created object and passes the name to the **Pre create** operation. To add the component, follow these steps: 1. In the **Mule Palette** view, search for **Transform Message**. 2. Drag **Transform Message** onto the canvas, to the right of **Listener**. 3. Enter the name `MyNewAccount`: ```dataweave %dw 2.0 %output application/java --- { Name: "MyNewAccount" } ``` ### Add the Pre Create Operation The Pre Create operation provides metadata for creating an object called `NewAccount` and generates a subrequest for the `executeCompositeBatch` operation. To add the operation, follow these steps: 1. In the **Mule Palette** view, search for `salesforce` and select the Salesforce Composite **Pre create** operation. 2. Drag the **Pre create** operation to the right of **Transform Message**. 3. Click the green plus icon (**+**) to the right of the **Connector configuration** field to access the Salesforce Composite global element configuration fields. 4. In the **Pre create** properties window, enter `Account` in the **Type** field. 5. In the properties file `src/main/mule/mule-app.properties`, declare and enter values for the variables in the global element. ![Salesforce Composite Connector global element configuration window](/mulesoft/current/en-us/salesforce-composite-connector/latest/_images/salesforce-composite-global-config.png) ### Add the Second Transform Message Component The second Transform Message component specifies values for the **ID** and **Type** fields, and then passes these values to the **Pre query** operation. To add the component, follow these steps: 1. Drag a second **Transform Message** component to the right of **Pre create**. 2. Enter the following name-value pairs: ```dataweave %dw 2.0 %output application/java --- { "Id": payload.Id, "Fields" : ["Id", "Name"], "Type": "Account" } ``` ### Add the Pre Query Operation The Pre Query operation provides metadata for an object to be queried. It generates a subrequest for the **Execute composite batch** operation. To add the operation, follow these steps: 1. Drag a Salesforce Composite **Pre query** operation to the right of the second **Transform Message**. 2. In the **Query** field, enter the following: `Select Name from Account WHERE Name LIKE '%:name %'` ### Add the Third Transform Message Component The third Transform Message operation passes the output of the **Pre query** operation to the **Execute composite batch** operation. To add the component, follow these steps: 1. Drag a third **Transform Message** component to the right of **Pre query**. 2. Set the output to `payload`: ```dataweave %dw 2.0 %output application/java --- [ payload ] ``` ### Add the Execute Composite Batch Operation The Execute Composite Batch operation executes the subrequests that the Pre Create and Pre Query operations created. To add the operation, drag a Salesforce Composite **Execute composite batch** operation to the right of the third **Transform Message**. ### Add the Fourth Transform Message Component The fourth Transform Message operation converts the output to JSON format. To add the component, follow these steps: 1. Drag a fourth **Transform Message** component to the right of **Execute composite batch**. 2. Set the output to `application/json`: ```dataweave %dw 2.0 %output application/json --- payload ``` ### XML for the Pre-Query Example Paste this code into your XML editor to quickly load the flow for this example to your Mule app. If needed, change the values to reflect your environment. ```xml Select Name from Account WHERE Name LIKE '%:name %' ``` ## See Also - [Salesforce Composite Connector Reference](https://docs.mulesoft.com/salesforce-composite-connector/latest/salesforce-composite-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.1 is-latest-version: true --- # Salesforce Composite Connector 3.1 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio. - If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/salesforce-composite http://www.mulesoft.org/schema/mule/salesforce-composite/current/mule-salesforce-composite.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule-salesforce-composite-connector x.x.x mule-plugin ``` Verify that the connector `version` corresponds to the one you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `salesforce composite`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/salesforce-composite-connector/latest/salesforce-composite-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.1 is-latest-version: true --- # Salesforce Composite Connector 3.1 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Default Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

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 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Max connections

Number

The maximum number of outbound connections to keep open at the same time. Use -1 for unlimited.

-1

Use persistent connections

Boolean

If set to false, each connection is closed after the first request completes.

true

Connection idle timeout

Number

How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.

30

Connection idle timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use for the Connection Idle Timeout parameter.

SECONDS

Reconnection

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

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.

### OAuth Client Credentials 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Max connections

Number

The maximum number of outbound connections to keep open at the same time. Use -1 for unlimited.

-1

Use persistent connections

Boolean

If set to false, each connection is closed after the first request completes.

true

Connection idle timeout

Number

How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.

30

Connection idle timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use for the Connection Idle Timeout parameter.

SECONDS

Reconnection

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

Client Id

String

The OAuth client ID as registered with the service provider.

x

Client Secret

String

The OAuth client secret as registered with the service provider.

x

Token Url

String

The service provider’s token 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.

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 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). > [!NOTE] When configuring a Salesforce external client app for OAuth JWT authentication, disable > **Issue JSON Web Token (JWT)-based access tokens for named users** so that Salesforce returns an > opaque access token instead of a JWT-formatted access token. #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Max connections

Number

The maximum number of outbound connections to keep open at the same time. Use -1 for unlimited.

-1

Use persistent connections

Boolean

If set to false, each connection is closed after the first request completes.

true

Connection idle timeout

Number

How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.

30

Connection idle timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use for the Connection Idle Timeout parameter.

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

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.

### OAuth SAML 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Max connections

Number

The maximum number of outbound connections to keep open at the same time. Use -1 for unlimited.

-1

Use persistent connections

Boolean

If set to false, each connection is closed after the first request completes.

true

Connection idle timeout

Number

How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.

30

Connection idle timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use for the Connection Idle Timeout parameter.

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

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
NameTypeDescriptionDefault ValueRequired

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 Time Unit.

30

Connection Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout.

SECONDS

Max connections

Number

The maximum number of outbound connections to keep open at the same time. Use -1 for unlimited.

-1

Use persistent connections

Boolean

If set to false, each connection is closed after the first request completes.

true

Connection idle timeout

Number

How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.

30

Connection idle timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use for the Connection Idle Timeout parameter.

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

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.

### Token Connection #### Parameters
NameTypeDescriptionDefault ValueRequired

Session Id

String

Session ID.

x

Instance Url

String

Instance URL.

x

TLS configuration

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

HTTP

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 Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Max connections

Number

The maximum number of outbound connections to keep open at the same time. Use -1 for unlimited.

-1

Use persistent connections

Boolean

If set to false, each connection is closed after the first request completes.

true

Connection idle timeout

Number

How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.

30

Connection idle timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use for the Connection Idle Timeout parameter.

SECONDS

Reconnection

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

## Operations - [Create Sobject Collections](#createSobjectCollections) - [Create sObject Tree](#createSobjectTree) - [Delete sObject Collections](#deleteSobjectCollections) - [Execute Composite Batch](#executeCompositeBatch) - [Execute Composite Graph](#executeCompositeGraph) - [Execute Composite Request](#executeCompositeRequest) - [Get sObject Collections](#getSobjectCollections) - [Post Create](#postCreate) - [Post Delete](#postDelete) - [Post Get Limits](#postGetLimits) - [Post Query](#postQuery) - [Post Query All](#postQueryAll) - [Post Retrieve](#postRetrieve) - [Post Search](#postSearch) - [Post Update](#postUpdate) - [Pre Create](#preCreate) - [Pre Delete](#preDelete) - [Pre Get Limits](#preGetLimits) - [Pre Query](#preQuery) - [Pre Query All](#preQueryAll) - [Pre Retrieve](#preRetrieve) - [Pre Search](#preSearch) - [Pre Update](#preUpdate) - [Unauthorize](#unauthorize) - [Update sObject Collections](#updateSobjectCollections) - [Upsert sObject Collections](#upsertSobjectCollections) ### 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Request Body

Object

The request body.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Sends a list of sObject trees to Salesforce to be created. #### Parameters
NameTypeDescriptionDefault ValueRequired

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]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Delete up to 200 records and return a list of `DeleteResult` objects. You can roll back the entire request if an error occurs. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Sub Requests

Array of Object

The list of subrequests to execute.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Performs composite requests by executing a series of REST API requests in a single call. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use

x

Graphs

Array of Object

List of graphs to execute

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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. > [!NOTE] You can add `httpHeaders` within `compositeRequest`, for example: > `"httpHeaders" : { "X-REQUEST-ID" : "ReferenceId" }`. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use

x

Request Body

Object

Request body

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Retrieve one or more records of the same object type. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Create Result

Object

The result of the create subrequest.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Delete Result

Object

The result of the delete subrequest.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Get Limits Result

Object

The result of the create subrequest.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

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

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Query Result

Object

The result of the create subrequest.

#[payload]

Streaming Strategy

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

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 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
NameTypeDescriptionDefault ValueRequired

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]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Search Result

Object

The result of the search subrequest.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Update Result

Object

The result of the update subrequest.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Provide metadata for getLimits and generate a subrequest for execution by `executeCompositeBatch(String, java.util.List)`. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` Provide the user a way to input a SOSL String and generate a subrequest for execution by `executeCompositeBatch(java.util.List)`. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Search

String

The SOSL string that is run in executeCompositeBatch.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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.

#[payload].

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The ID of the resource owner for whom to invalidate access

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

#### For Configurations - [Default Configuration](#composite-config) ### 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
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Request Body

Object

The request body.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 `` 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
NameTypeDescriptionDefault ValueRequired

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]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

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]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type a

Array of Object

Attributes Type a

Object

#### For Configurations - [Default Configuration](#composite-config) #### 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 Configures TLS to provide secure communications for the Mule app.
FieldTypeDescriptionDefault ValueRequired

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

Contains the configuration parameters for the trust store configuration

Key Store Configuration

Contains the configuration parameters for the key store configuration

Revocation Check

### Trust Store Configuration Configures the truststore for TLS.
FieldTypeDescriptionDefault ValueRequired

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 Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
FieldTypeDescriptionDefault ValueRequired

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 Configures standard revocation checks for TLS certificates.
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer CRLs

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the Prefer CRLs field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

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

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.
FieldTypeDescriptionDefault ValueRequired

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 Specifies the location of the certification revocation list (CRL) file.
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection Configures a reconnection strategy for an operation.
FieldTypeDescriptionDefault ValueRequired

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 Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to reconnect (in milliseconds).

Blocking

Boolean

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

Count

Number

The number of reconnection attempts to make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

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

### Expiration Policy Configures an expiration policy strategy.
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

In Memory Objects

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

Unit for the In Memory Objects field.

### Error Mapping
FieldTypeDescriptionDefault ValueRequired

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

## See Also [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.0 --- # Upgrading and Migrating Salesforce Composite Connector to Version 3.x > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade Anypoint Connector for Salesforce Composite (Salesforce Composite Connector) to version 3.x. ## Supported Upgrade Paths
From VersionTo Version

2.x

3.x

## Changes in This Release - This connector is now compatible with Java 17 only. - The connector now supports the new **OAuth Client Credentials** connection type. ## Requirements Ensure your system meets the following compatibility requirements before you perform the upgrade:
Application/ServiceVersion

Mule

4.9.0 and later

Java

17

## Upgrade Prerequisites Before you perform the upgrade, create a backup of your files, data, and configuration in case you need to restore to the previous version. ## Upgrade Steps Follow these steps to perform the upgrade to version 3.x: 1. In Anypoint Studio, create a Mule project. 2. In the **Mule Palette** view, click **Search in Exchange**. 3. In **Add Dependencies to Project**, enter `salesforce composite` in the search field. 4. In **Available modules**, select **Salesforce Composite** and click **Add**. 5. Click **Finish**. 6. Verify that the Salesforce Composite dependency version is `3.x` in the project’s `pom.xml` file. Studio upgrades the connector automatically. ## Post-Upgrade Steps After you install the latest version of the connector, verify that your error handling is updated to work with the minor changes in error codes in this version of the connector. ## Verify the Upgrade After you install the latest version of the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Verify that there are no problems in the project `pom.xml` file. 3. Test the connection to verify that the operations work. ## Revert the Upgrade If it is necessary to revert to the previous version of Salesforce Composite, change the `mule-salesforce-composite` dependency version in the project’s `pom.xml` file to the previous version. You must update the project’s `pom.xml` file in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.1 is-latest-version: true --- # Upgrading and Migrating Salesforce Composite Connector to Version 3.x > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Upgrade Anypoint Connector for Salesforce Composite (Salesforce Composite Connector) to version 3.x. ## Supported Upgrade Paths
From VersionTo Version

2.x

3.x

## Changes in This Release - This connector is now compatible with Java 17 only. - The connector now supports the new **OAuth Client Credentials** connection type. ## Requirements Ensure your system meets the following compatibility requirements before you perform the upgrade:
Application/ServiceVersion

Mule

4.9.0 and later

Java

17

## Upgrade Prerequisites Before you perform the upgrade, create a backup of your files, data, and configuration in case you need to restore to the previous version. ## Upgrade Steps Follow these steps to perform the upgrade to version 3.x: 1. In Anypoint Studio, create a Mule project. 2. In the **Mule Palette** view, click **Search in Exchange**. 3. In **Add Dependencies to Project**, enter `salesforce composite` in the search field. 4. In **Available modules**, select **Salesforce Composite** and click **Add**. 5. Click **Finish**. 6. Verify that the Salesforce Composite dependency version is `3.x` in the project’s `pom.xml` file. Studio upgrades the connector automatically. ## Post-Upgrade Steps After you install the latest version of the connector, verify that your error handling is updated to work with the minor changes in error codes in this version of the connector. ## Verify the Upgrade After you install the latest version of the connector, follow these steps to verify the upgrade: 1. In Studio, verify that there are no errors in the **Problems** or **Console** views. 2. Verify that there are no problems in the project `pom.xml` file. 3. Test the connection to verify that the operations work. ## Revert the Upgrade If it is necessary to revert to the previous version of Salesforce Composite, change the `mule-salesforce-composite` dependency version in the project’s `pom.xml` file to the previous version. You must update the project’s `pom.xml` file in Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.19 --- # Using Anypoint Studio to Configure Salesforce Composite Connector 2.19 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Salesforce Composite Reference](https://docs.mulesoft.com/salesforce-composite-connector/2.19/salesforce-composite-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. Select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Salesforce Composite Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `salesforce composite` in the search field. 3. Click **Salesforce Composite** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Salesforce Composite Connector: - HTTP **Listener** Initiates a flow each time it receives a request on the configured host and port - **Scheduler** Initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to **Connector configuration** to configure a global element that can be used by all instances of HTTP Listener in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Salesforce Composite Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce Composite** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Salesforce Composite system. Salesforce Composite Connector supports OAuth v2.0, OAuth JWT, OAuth SAML, and OAuth Username and Password. To configure the global element for Salesforce Composite Connector, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the authentication method to configure: - **OAuth v2.0** - **OAuth JWT** - **OAuth SAML** - **[OAuth Username and Password](#oauth-username-password)** - **Token Connection** You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### OAuth Username and Password Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Basic authentication: - Consumer Key The consumer key for the Salesforce connected app - Consumer Secret The consumer secret for the connector to access Salesforce - Username The Salesforce username - Password The corresponding password - Security Token The corresponding security token ![Global configuration window for Basic Authentication](/mulesoft/current/en-us/salesforce-composite-connector/2.19/_images/salesforce-composite-studio-basic-auth.png) Figure 1. The basic authentication includes a consumer key, consumer secret, username, and password. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step After you configure a global element and connection information, configure the other fields for the connector. See [Examples](https://docs.mulesoft.com/salesforce-composite-connector/2.19/salesforce-composite-connector-examples) for use cases. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Composite Connector Reference](https://docs.mulesoft.com/salesforce-composite-connector/2.19/salesforce-composite-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.20 --- # Using Anypoint Studio to Configure Salesforce Composite Connector 2.20 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Salesforce Composite Reference](https://docs.mulesoft.com/salesforce-composite-connector/2.20/salesforce-composite-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. Select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Salesforce Composite Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `salesforce composite` in the search field. 3. Click **Salesforce Composite** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Salesforce Composite Connector: - HTTP **Listener** Initiates a flow each time it receives a request on the configured host and port - **Scheduler** Initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to **Connector configuration** to configure a global element that can be used by all instances of HTTP Listener in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Salesforce Composite Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce Composite** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Salesforce Composite system. Salesforce Composite Connector supports OAuth v2.0, OAuth JWT, OAuth SAML, and OAuth Username and Password. To configure the global element for Salesforce Composite Connector, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the authentication method to configure: - **OAuth v2.0** - **OAuth JWT** - **OAuth SAML** - **[OAuth Username and Password](#oauth-username-password)** - **Token Connection** You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### OAuth Username and Password Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Basic authentication: - Consumer Key The consumer key for the Salesforce connected app - Consumer Secret The consumer secret for the connector to access Salesforce - Username The Salesforce username - Password The corresponding password - Security Token The corresponding security token ![Global configuration window for Basic Authentication](/mulesoft/current/en-us/salesforce-composite-connector/2.20/_images/salesforce-composite-studio-basic-auth.png) Figure 1. The basic authentication includes a consumer key, consumer secret, username, and password. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step After you configure a global element and connection information, configure the other fields for the connector. See [Examples](https://docs.mulesoft.com/salesforce-composite-connector/2.20/salesforce-composite-connector-examples) for use cases. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Composite Connector Reference](https://docs.mulesoft.com/salesforce-composite-connector/2.20/salesforce-composite-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 2.21 --- # Using Anypoint Studio to Configure Salesforce Composite Connector 2.21 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Salesforce Composite Reference](https://docs.mulesoft.com/salesforce-composite-connector/2.21/salesforce-composite-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. Select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Salesforce Composite Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `salesforce composite` in the search field. 3. Click **Salesforce Composite** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Salesforce Composite Connector: - HTTP **Listener** Initiates a flow each time it receives a request on the configured host and port - **Scheduler** Initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to **Connector configuration** to configure a global element that can be used by all instances of HTTP Listener in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Salesforce Composite Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce Composite** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Salesforce Composite system. Salesforce Composite Connector supports OAuth v2.0, OAuth JWT, OAuth SAML, and OAuth Username and Password. To configure the global element for Salesforce Composite Connector, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the authentication method to configure: - **OAuth v2.0** - **OAuth JWT** - **OAuth SAML** - **[OAuth Username and Password](#oauth-username-password)** - **Token Connection** You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### OAuth Username and Password Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Basic authentication: - Consumer Key The consumer key for the Salesforce connected app - Consumer Secret The consumer secret for the connector to access Salesforce - Username The Salesforce username - Password The corresponding password - Security Token The corresponding security token ![Global configuration window for Basic Authentication](/mulesoft/current/en-us/salesforce-composite-connector/2.21/_images/salesforce-composite-studio-basic-auth.png) Figure 1. The basic authentication includes a consumer key, consumer secret, username, and password. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step After you configure a global element and connection information, configure the other fields for the connector. See [Examples](https://docs.mulesoft.com/salesforce-composite-connector/2.21/salesforce-composite-connector-examples) for use cases. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Composite Connector Reference](https://docs.mulesoft.com/salesforce-composite-connector/2.21/salesforce-composite-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.0 --- # Using Anypoint Studio to Configure Salesforce Composite Connector 3.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Salesforce Composite Reference](https://docs.mulesoft.com/salesforce-composite-connector/3.0/salesforce-composite-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. Select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Salesforce Composite Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `salesforce composite` in the search field. 3. Click **Salesforce Composite** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Salesforce Composite Connector: - HTTP **Listener** Initiates a flow each time it receives a request on the configured host and port - **Scheduler** Initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to **Connector configuration** to configure a global element that can be used by all instances of HTTP Listener in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Salesforce Composite Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce Composite** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Salesforce Composite system. Salesforce Composite Connector supports OAuth v2.0, OAuth Client Credentials, OAuth JWT, OAuth SAML, and OAuth Username and Password. To configure the global element for Salesforce Composite Connector, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the authentication method to configure: - **OAuth v2.0** - **[OAuth Client Credentials](#oauth-client-credentials)** - **OAuth JWT** - **OAuth SAML** - **[OAuth Username and Password](#oauth-username-password)** - **Token Connection** You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### OAuth Username and Password Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Basic authentication: - Consumer Key The consumer key for the Salesforce connected app - Consumer Secret The consumer secret for the connector to access Salesforce - Username The Salesforce username - Password The corresponding password - Security Token The corresponding security token ![Global configuration window for Basic Authentication](/mulesoft/current/en-us/salesforce-composite-connector/3.0/_images/salesforce-composite-studio-basic-auth.png) Figure 1. The basic authentication includes a consumer key, consumer secret, username, and password. ### OAuth Client Credentials Enter the following information on the **General** tab of the **Global Element Properties** screen to configure OAuth client credentials authentication: - Client Id The OAuth client ID for the Salesforce connected app - Client Secret The OAuth client secret for the Salesforce connected app - Token Url The token endpoint URL used to request access tokens - Scopes (Optional) The OAuth scopes to request for the connection ![Global configuration window for OAuth Client Credentials](/mulesoft/current/en-us/salesforce-composite-connector/3.0/_images/salesforce-composite-studio-oauth-client-credentials.png) Figure 2. OAuth client credentials authentication includes a client ID, client secret, token URL, and optional scopes. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step After you configure a global element and connection information, configure the other fields for the connector. See [Examples](https://docs.mulesoft.com/salesforce-composite-connector/3.0/salesforce-composite-connector-examples) for use cases. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Composite Connector Reference](https://docs.mulesoft.com/salesforce-composite-connector/3.0/salesforce-composite-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Salesforce Composite Connector version: 3.1 is-latest-version: true --- # Using Anypoint Studio to Configure Salesforce Composite Connector 3.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). When you run the connector, you can view the app log to check for problems, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Salesforce Composite Reference](https://docs.mulesoft.com/salesforce-composite-connector/latest/salesforce-composite-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. Select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Salesforce Composite Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `salesforce composite` in the search field. 3. Click **Salesforce Composite** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Salesforce Composite Connector: - HTTP **Listener** Initiates a flow each time it receives a request on the configured host and port - **Scheduler** Initiates a flow when a time-based condition is met For example, to configure an HTTP listener, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to **Connector configuration** to configure a global element that can be used by all instances of HTTP Listener in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Salesforce Composite Connector, follow these steps: 1. In the **Mule Palette** view, select **Salesforce Composite** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Salesforce Composite system. Salesforce Composite Connector supports OAuth v2.0, OAuth Client Credentials, OAuth JWT, OAuth SAML, and OAuth Username and Password. To configure the global element for Salesforce Composite Connector, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the authentication method to configure: - **OAuth v2.0** - **[OAuth Client Credentials](#oauth-client-credentials)** - **OAuth JWT** - **OAuth SAML** - **[OAuth Username and Password](#oauth-username-password)** - **Token Connection** You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify connection pooling and reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### OAuth Username and Password Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Basic authentication: - Consumer Key The consumer key for the Salesforce connected app - Consumer Secret The consumer secret for the connector to access Salesforce - Username The Salesforce username - Password The corresponding password - Security Token The corresponding security token ![Global configuration window for Basic Authentication](/mulesoft/current/en-us/salesforce-composite-connector/latest/_images/salesforce-composite-studio-basic-auth.png) Figure 1. The basic authentication includes a consumer key, consumer secret, username, and password. ### OAuth Client Credentials 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](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). Enter the following information on the **General** tab of the **Global Element Properties** screen to configure OAuth client credentials authentication: - Client Id The OAuth client ID for the Salesforce connected app - Client Secret The OAuth client secret for the Salesforce connected app - Token Url The token endpoint URL used to request access tokens - Scopes (Optional) The OAuth scopes to request for the connection ![Global configuration window for OAuth Client Credentials](/mulesoft/current/en-us/salesforce-composite-connector/latest/_images/salesforce-composite-studio-oauth-client-credentials.png) Figure 2. OAuth client credentials authentication includes a client ID, client secret, token URL, and optional scopes. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## Next Step After you configure a global element and connection information, configure the other fields for the connector. See [Examples](https://docs.mulesoft.com/salesforce-composite-connector/latest/salesforce-composite-connector-examples) for use cases. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Composite Connector Reference](https://docs.mulesoft.com/salesforce-composite-connector/latest/salesforce-composite-connector-reference) - [Salesforce Help](https://help.salesforce.com)