Chapter 54. Salesforce
Both producer and consumer are supported
This component supports producer and consumer endpoints to communicate with Salesforce using Java DTOs.
There is a companion maven plugin Camel Salesforce Plugin that generates these DTOs (see further below).
Maven users must add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-salesforce</artifactId>
<version>{CamelSBVersion}</version>
<!-- use the same version as your Camel core version -->
</dependency>
By default, camel-salesforce-maven-plugin uses TLSv1.3 to interact with salesforce. TLS version is configurable on the plugin. FIPS users can configure the property sslContextParameters.secureSocketProtocol. To use the maven-plugin you must add the following dependency to the pom.xml file.
<plugin>
<groupId>org.apache.camel.maven</groupId>
<artifactId>camel-salesforce-maven-plugin</artifactId>
<version>${camel-community.version}</version>
<executions>
<execution>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<clientId>${camelSalesforce.clientId}</clientId>
<clientSecret>${camelSalesforce.clientSecret}</clientSecret>
<userName>${camelSalesforce.userName}</userName>
<password>${camelSalesforce.password}</password>
<sslContextParameters>
<secureSocketProtocol>TLSv1.2</secureSocketProtocol>
</sslContextParameters>
<includes>
<include>Contact</include>
</includes>
</configuration>
</execution>
</executions>
</plugin>Developers wishing to contribute to the component are instructed to look at the link:https://github.com/apache/camel/tree/main/components/camel-salesforce/camel-salesforce-component/README.md[README.md] file on instructions on how to get started and setup your environment for running integration tests.
54.1. Configuring Options
Camel components are configured on two separate levels:
- component level
- endpoint level
54.1.1. Configuring Component Options
The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.
54.1.2. Configuring Endpoint Options
Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.
A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.
The following two sections lists all the options, firstly for the component followed by the endpoint.
54.2. Component Options
The Salesforce component supports 90 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| apexMethod (common) | APEX method name. | String | |
| apexQueryParams (common) | Query params for APEX method. | Map | |
| apiVersion (common) | Salesforce API version. | 53.0 | String |
| backoffIncrement (common) | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | 1000 | long |
| batchId (common) | Bulk API Batch ID. | String | |
| contentType (common) | Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV. Enum values:
| ContentType | |
| defaultReplayId (common) | Default replayId setting if no value is found in initialReplayIdMap. | -1 | Long |
| fallBackReplayId (common) | ReplayId to fall back to after an Invalid Replay Id response. | -1 | Long |
| format (common) | Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON. As of Camel 3.12, this option only applies to the Raw operation. Enum values:
| PayloadFormat | |
| httpClient (common) | Custom Jetty Http Client to use to connect to Salesforce. | SalesforceHttpClient | |
| httpClientConnectionTimeout (common) | Connection timeout used by the HttpClient when connecting to the Salesforce server. | 60000 | long |
| httpClientIdleTimeout (common) | Timeout used by the HttpClient when waiting for response from the Salesforce server. | 10000 | long |
| httpMaxContentLength (common) | Max content length of an HTTP response. | Integer | |
| httpRequestBufferSize (common) | HTTP request buffer size. May need to be increased for large SOQL queries. | 8192 | Integer |
| includeDetails (common) | Include details in Salesforce1 Analytics report, defaults to false. | Boolean | |
| initialReplayIdMap (common) | Replay IDs to start from per channel name. | Map | |
| instanceId (common) | Salesforce1 Analytics report execution instance ID. | String | |
| jobId (common) | Bulk API Job ID. | String | |
| limit (common) | Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation. | Integer | |
| locator (common) | Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job. | String | |
| maxBackoff (common) | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | 30000 | long |
| maxRecords (common) | The maximum number of records to retrieve per set of results for a Bulk 2.0 Query. The request is still subject to the size limits. If you are working with a very large number of query results, you may experience a timeout before receiving all the data from Salesforce. To prevent a timeout, specify the maximum number of records your client is expecting to receive in the maxRecords parameter. This splits the results into smaller sets with this value as the maximum size. | Integer | |
| notFoundBehaviour (common) | Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL NotFoundBehaviour#NULL or should a exception be signaled on the exchange NotFoundBehaviour#EXCEPTION - the default. Enum values:
| EXCEPTION | NotFoundBehaviour |
| notifyForFields (common) | Notify for fields, options are ALL, REFERENCED, SELECT, WHERE. Enum values:
| NotifyForFieldsEnum | |
| notifyForOperationCreate (common) | Notify for create operation, defaults to false (API version = 29.0). | Boolean | |
| notifyForOperationDelete (common) | Notify for delete operation, defaults to false (API version = 29.0). | Boolean | |
| notifyForOperations (common) | Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version 29.0). Enum values:
| NotifyForOperationsEnum | |
| notifyForOperationUndelete (common) | Notify for un-delete operation, defaults to false (API version = 29.0). | Boolean | |
| notifyForOperationUpdate (common) | Notify for update operation, defaults to false (API version = 29.0). | Boolean | |
| objectMapper (common) | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. | ObjectMapper | |
| packages (common) | In what packages are the generated DTO classes. Typically the classes would be generated using camel-salesforce-maven-plugin. Set it if using the generated DTOs to gain the benefit of using short SObject names in parameters/header values. Multiple packages can be separated by comma. | String | |
| pkChunking (common) | Use PK Chunking. Only for use in original Bulk API. Bulk 2.0 API performs PK chunking automatically, if necessary. | Boolean | |
| pkChunkingChunkSize (common) | Chunk size for use with PK Chunking. If unspecified, salesforce default is 100,000. Maximum size is 250,000. | Integer | |
| pkChunkingParent (common) | Specifies the parent object when you’re enabling PK chunking for queries on sharing objects. The chunks are based on the parent object’s records rather than the sharing object’s records. For example, when querying on AccountShare, specify Account as the parent object. PK chunking is supported for sharing objects as long as the parent object is supported. | String | |
| pkChunkingStartRow (common) | Specifies the 15-character or 18-character record ID to be used as the lower boundary for the first chunk. Use this parameter to specify a starting ID when restarting a job that failed between batches. | String | |
| queryLocator (common) | Query Locator provided by salesforce for use when a query results in more records than can be retrieved in a single call. Use this value in a subsequent call to retrieve additional records. | String | |
| rawPayload (common) | Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default. | false | boolean |
| reportId (common) | Salesforce1 Analytics report Id. | String | |
| reportMetadata (common) | Salesforce1 Analytics report metadata for filtering. | ReportMetadata | |
| resultId (common) | Bulk API Result ID. | String | |
| sObjectBlobFieldName (common) | SObject blob field name. | String | |
| sObjectClass (common) | Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin. | String | |
| sObjectFields (common) | SObject fields to retrieve. | String | |
| sObjectId (common) | SObject ID if required by API. | String | |
| sObjectIdName (common) | SObject external ID field name. | String | |
| sObjectIdValue (common) | SObject external ID field value. | String | |
| sObjectName (common) | SObject name if required or supported by API. | String | |
| sObjectQuery (common) | Salesforce SOQL query string. | String | |
| sObjectSearch (common) | Salesforce SOSL search string. | String | |
| updateTopic (common) | Whether to update an existing Push Topic when using the Streaming API, defaults to false. | false | boolean |
| config (common (advanced)) | Global endpoint configuration - use to set values that are common to all endpoints. | SalesforceEndpointConfig | |
| httpClientProperties (common (advanced)) | Used to set any properties that can be configured on the underlying HTTP client. Have a look at properties of SalesforceHttpClient and the Jetty HttpClient for all available options. | Map | |
| longPollingTransportProperties (common (advanced)) | Used to set any properties that can be configured on the LongPollingTransport used by the BayeuxClient (CometD) used by the streaming api. | Map | |
| workerPoolMaxSize (common (advanced)) | Maximum size of the thread pool used to handle HTTP responses. | 20 | int |
| workerPoolSize (common (advanced)) | Size of the thread pool used to handle HTTP responses. | 10 | int |
| bridgeErrorHandler (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean |
| allOrNone (producer) | Composite API option to indicate to rollback all records if any are not successful. | false | boolean |
| apexUrl (producer) | APEX method URL. | String | |
| compositeMethod (producer) | Composite (raw) method. | String | |
| lazyStartProducer (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean |
| rawHttpHeaders (producer) | Comma separated list of message headers to include as HTTP parameters for Raw operation. | String | |
| rawMethod (producer) | HTTP method to use for the Raw operation. | String | |
| rawPath (producer) | The portion of the endpoint URL after the domain name. E.g., '/services/data/v52.0/sobjects/Account/'. | String | |
| rawQueryParameters (producer) | Comma separated list of message headers to include as query parameters for Raw operation. Do not url-encode values as this will be done automatically. | String | |
| autowiredEnabled (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean |
| httpProxyExcludedAddresses (proxy) | A list of addresses for which HTTP proxy server should not be used. | Set | |
| httpProxyHost (proxy) | Hostname of the HTTP proxy server to use. | String | |
| httpProxyIncludedAddresses (proxy) | A list of addresses for which HTTP proxy server should be used. | Set | |
| httpProxyPort (proxy) | Port number of the HTTP proxy server to use. | Integer | |
| httpProxySocks4 (proxy) | If set to true the configures the HTTP proxy to use as a SOCKS4 proxy. | false | boolean |
| authenticationType (security) | Explicit authentication method to be used, one of USERNAME_PASSWORD, REFRESH_TOKEN or JWT. Salesforce component can auto-determine the authentication method to use from the properties set, set this property to eliminate any ambiguity. Enum values:
| AuthenticationType | |
| clientId (security) | Required OAuth Consumer Key of the connected app configured in the Salesforce instance setup. Typically a connected app needs to be configured but one can be provided by installing a package. | String | |
| clientSecret (security) | OAuth Consumer Secret of the connected app configured in the Salesforce instance setup. | String | |
| httpProxyAuthUri (security) | Used in authentication against the HTTP proxy server, needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication. | String | |
| httpProxyPassword (security) | Password to use to authenticate against the HTTP proxy server. | String | |
| httpProxyRealm (security) | Realm of the proxy server, used in preemptive Basic/Digest authentication methods against the HTTP proxy server. | String | |
| httpProxySecure (security) | If set to false disables the use of TLS when accessing the HTTP proxy. | true | boolean |
| httpProxyUseDigestAuth (security) | If set to true Digest authentication will be used when authenticating to the HTTP proxy, otherwise Basic authorization method will be used. | false | boolean |
| httpProxyUsername (security) | Username to use to authenticate against the HTTP proxy server. | String | |
| instanceUrl (security) | URL of the Salesforce instance used after authentication, by default received from Salesforce on successful authentication. | String | |
| jwtAudience (security) | Value to use for the Audience claim (aud) when using OAuth JWT flow. If not set, the login URL will be used, which is appropriate in most cases. | String | |
| keystore (security) | KeyStore parameters to use in OAuth JWT flow. The KeyStore should contain only one entry with private key and certificate. Salesforce does not verify the certificate chain, so this can easily be a selfsigned certificate. Make sure that you upload the certificate to the corresponding connected app. | KeyStoreParameters | |
| lazyLogin (security) | If set to true prevents the component from authenticating to Salesforce with the start of the component. You would generally set this to the (default) false and authenticate early and be immediately aware of any authentication issues. | false | boolean |
| loginConfig (security) | All authentication configuration in one nested bean, all properties set there can be set directly on the component as well. | SalesforceLoginConfig | |
| loginUrl (security) | Required URL of the Salesforce instance used for authentication, by default set to https://login.salesforce.com. | String | |
| password (security) | Password used in OAuth flow to gain access to access token. It’s easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. Make sure that you append security token to the end of the password if using one. | String | |
| refreshToken (security) | Refresh token already obtained in the refresh token OAuth flow. One needs to setup a web application and configure a callback URL to receive the refresh token, or configure using the builtin callback at https://login.salesforce.com/services/oauth2/success or https://test.salesforce.com/services/oauth2/success and then retrive the refresh_token from the URL at the end of the flow. Note that in development organizations Salesforce allows hosting the callback web application at localhost. | String | |
| sslContextParameters (security) | SSL parameters to use, see SSLContextParameters class for all available options. | SSLContextParameters | |
| useGlobalSslContextParameters (security) | Enable usage of global SSL context parameters. | false | boolean |
| userName (security) | Username used in OAuth flow to gain access to access token. It’s easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. | String |
54.3. Endpoint Options
The Salesforce endpoint is configured using URI syntax:
salesforce:operationName:topicName
with the following path and query parameters:
54.3.1. Path Parameters (2 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
| operationName (producer) | The operation to use. Enum values:
| OperationName | |
| topicName (consumer) | The name of the topic/channel to use. | String |
54.3.2. Query Parameters (57 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
| apexMethod (common) | APEX method name. | String | |
| apexQueryParams (common) | Query params for APEX method. | Map | |
| apiVersion (common) | Salesforce API version. | 53.0 | String |
| backoffIncrement (common) | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | 1000 | long |
| batchId (common) | Bulk API Batch ID. | String | |
| contentType (common) | Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV. Enum values:
| ContentType | |
| defaultReplayId (common) | Default replayId setting if no value is found in initialReplayIdMap. | -1 | Long |
| fallBackReplayId (common) | ReplayId to fall back to after an Invalid Replay Id response. | -1 | Long |
| format (common) | Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON. As of Camel 3.12, this option only applies to the Raw operation. Enum values:
| PayloadFormat | |
| httpClient (common) | Custom Jetty Http Client to use to connect to Salesforce. | SalesforceHttpClient | |
| includeDetails (common) | Include details in Salesforce1 Analytics report, defaults to false. | Boolean | |
| initialReplayIdMap (common) | Replay IDs to start from per channel name. | Map | |
| instanceId (common) | Salesforce1 Analytics report execution instance ID. | String | |
| jobId (common) | Bulk API Job ID. | String | |
| limit (common) | Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation. | Integer | |
| locator (common) | Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job. | String | |
| maxBackoff (common) | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | 30000 | long |
| maxRecords (common) | The maximum number of records to retrieve per set of results for a Bulk 2.0 Query. The request is still subject to the size limits. If you are working with a very large number of query results, you may experience a timeout before receiving all the data from Salesforce. To prevent a timeout, specify the maximum number of records your client is expecting to receive in the maxRecords parameter. This splits the results into smaller sets with this value as the maximum size. | Integer | |
| notFoundBehaviour (common) | Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL NotFoundBehaviour#NULL or should a exception be signaled on the exchange NotFoundBehaviour#EXCEPTION - the default. Enum values:
| EXCEPTION | NotFoundBehaviour |
| notifyForFields (common) | Notify for fields, options are ALL, REFERENCED, SELECT, WHERE. Enum values:
| NotifyForFieldsEnum | |
| notifyForOperationCreate (common) | Notify for create operation, defaults to false (API version = 29.0). | Boolean | |
| notifyForOperationDelete (common) | Notify for delete operation, defaults to false (API version = 29.0). | Boolean | |
| notifyForOperations (common) | Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version 29.0). Enum values:
| NotifyForOperationsEnum | |
| notifyForOperationUndelete (common) | Notify for un-delete operation, defaults to false (API version = 29.0). | Boolean | |
| notifyForOperationUpdate (common) | Notify for update operation, defaults to false (API version = 29.0). | Boolean | |
| objectMapper (common) | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. | ObjectMapper | |
| pkChunking (common) | Use PK Chunking. Only for use in original Bulk API. Bulk 2.0 API performs PK chunking automatically, if necessary. | Boolean | |
| pkChunkingChunkSize (common) | Chunk size for use with PK Chunking. If unspecified, salesforce default is 100,000. Maximum size is 250,000. | Integer | |
| pkChunkingParent (common) | Specifies the parent object when you’re enabling PK chunking for queries on sharing objects. The chunks are based on the parent object’s records rather than the sharing object’s records. For example, when querying on AccountShare, specify Account as the parent object. PK chunking is supported for sharing objects as long as the parent object is supported. | String | |
| pkChunkingStartRow (common) | Specifies the 15-character or 18-character record ID to be used as the lower boundary for the first chunk. Use this parameter to specify a starting ID when restarting a job that failed between batches. | String | |
| queryLocator (common) | Query Locator provided by salesforce for use when a query results in more records than can be retrieved in a single call. Use this value in a subsequent call to retrieve additional records. | String | |
| rawPayload (common) | Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default. | false | boolean |
| reportId (common) | Salesforce1 Analytics report Id. | String | |
| reportMetadata (common) | Salesforce1 Analytics report metadata for filtering. | ReportMetadata | |
| resultId (common) | Bulk API Result ID. | String | |
| sObjectBlobFieldName (common) | SObject blob field name. | String | |
| sObjectClass (common) | Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin. | String | |
| sObjectFields (common) | SObject fields to retrieve. | String | |
| sObjectId (common) | SObject ID if required by API. | String | |
| sObjectIdName (common) | SObject external ID field name. | String | |
| sObjectIdValue (common) | SObject external ID field value. | String | |
| sObjectName (common) | SObject name if required or supported by API. | String | |
| sObjectQuery (common) | Salesforce SOQL query string. | String | |
| sObjectSearch (common) | Salesforce SOSL search string. | String | |
| updateTopic (common) | Whether to update an existing Push Topic when using the Streaming API, defaults to false. | false | boolean |
| bridgeErrorHandler (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean |
| replayId (consumer) | The replayId value to use when subscribing. | Long | |
| exceptionHandler (consumer (advanced)) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | ExceptionHandler | |
| exchangePattern (consumer (advanced)) | Sets the exchange pattern when the consumer creates an exchange. Enum values:
| ExchangePattern | |
| allOrNone (producer) | Composite API option to indicate to rollback all records if any are not successful. | false | boolean |
| apexUrl (producer) | APEX method URL. | String | |
| compositeMethod (producer) | Composite (raw) method. | String | |
| lazyStartProducer (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean |
| rawHttpHeaders (producer) | Comma separated list of message headers to include as HTTP parameters for Raw operation. | String | |
| rawMethod (producer) | HTTP method to use for the Raw operation. | String | |
| rawPath (producer) | The portion of the endpoint URL after the domain name. E.g., '/services/data/v52.0/sobjects/Account/'. | String | |
| rawQueryParameters (producer) | Comma separated list of message headers to include as query parameters for Raw operation. Do not url-encode values as this will be done automatically. | String |
54.4. Authenticating to Salesforce
The component supports three OAuth authentication flows:
For each of the flow different set of properties needs to be set:
| Property | Where to find it on Salesforce | Flow |
|---|---|---|
| clientId | Connected App, Consumer Key | All flows |
| clientSecret | Connected App, Consumer Secret | Username-Password, Refresh Token |
| userName | Salesforce user username | Username-Password, JWT Bearer Token |
| password | Salesforce user password | Username-Password |
| refreshToken | From OAuth flow callback | Refresh Token |
| keystore | Connected App, Digital Certificate | JWT Bearer Token |
The component auto determines what flow you’re trying to configure, to be remove ambiguity set the authenticationType property.
Using Username-Password Flow in production is not encouraged.
The certificate used in JWT Bearer Token Flow can be a selfsigned certificate. The KeyStore holding the certificate and the private key must contain only single certificate-private key entry.
54.5. URI format
When used as a consumer, receiving streaming events, the URI scheme is:
salesforce:topic?options
When used as a producer, invoking the Salesforce REST APIs, the URI scheme is:
salesforce:operationName?options
54.6. Passing in Salesforce headers and fetching Salesforce response headers
There is support to pass Salesforce headers via inbound message headers, header names that start with Sforce or x-sfdc on the Camel message will be passed on in the request, and response headers that start with Sforce will be present in the outbound message headers.
For example to fetch API limits you can specify:
// in your Camel route set the header before Salesforce endpoint
//...
.setHeader("Sforce-Limit-Info", constant("api-usage"))
.to("salesforce:getGlobalObjects")
.to(myProcessor);
// myProcessor will receive `Sforce-Limit-Info` header on the outbound
// message
class MyProcessor implements Processor {
public void process(Exchange exchange) throws Exception {
Message in = exchange.getIn();
String apiLimits = in.getHeader("Sforce-Limit-Info", String.class);
}
}
In addition, HTTP response status code and text are available as headers Exchange.HTTP_RESPONSE_CODE and Exchange.HTTP_RESPONSE_TEXT.
54.7. Supported Salesforce APIs
The component supports the following Salesforce APIs
Producer endpoints can use the following APIs. Most of the APIs process one record at a time, the Query API can retrieve multiple Records.
54.7.1. Rest API
You can use the following for operationName:
- getVersions - Gets supported Salesforce REST API versions
- getResources - Gets available Salesforce REST Resource endpoints
- getGlobalObjects - Gets metadata for all available SObject types
- getBasicInfo - Gets basic metadata for a specific SObject type
- getDescription - Gets comprehensive metadata for a specific SObject type
- getSObject - Gets an SObject using its Salesforce Id
- createSObject - Creates an SObject
- updateSObject - Updates an SObject using Id
- deleteSObject - Deletes an SObject using Id
- getSObjectWithId - Gets an SObject using an external (user defined) id field
- upsertSObject - Updates or inserts an SObject using an external id
- deleteSObjectWithId - Deletes an SObject using an external id
- query - Runs a Salesforce SOQL query
- queryMore - Retrieves more results (in case of large number of results) using result link returned from the 'query' API
- search - Runs a Salesforce SOSL query
- limits - fetching organization API usage limits
- recent - fetching recent items
- approval - submit a record or records (batch) for approval process
- approvals - fetch a list of all approval processes
- composite - submit up to 25 possibly related REST requests and receive individual responses. It’s also possible to use "raw" composite without limitation.
- composite-tree - create up to 200 records with parent-child relationships (up to 5 levels) in one go
- composite-batch - submit a composition of requests in batch
- compositeRetrieveSObjectCollections - Retrieve one or more records of the same object type.
- compositeCreateSObjectCollections - Add up to 200 records, returning a list of SaveSObjectResult objects.
- compositeUpdateSObjectCollections - Update up to 200 records, returning a list of SaveSObjectResult objects.
- compositeUpsertSObjectCollections - Create or update (upsert) up to 200 records based on an external ID field. Returns a list of UpsertSObjectResult objects.
- compositeDeleteSObjectCollections - Delete up to 200 records, returning a list of SaveSObjectResult objects.
- queryAll - Runs a SOQL query. It returns the results that are deleted because of a merge (merges up to three records into one of the records, deletes the others, and reparents any related records) or delete. Also returns the information about archived Task and Event records.
- getBlobField - Retrieves the specified blob field from an individual record.
- apexCall - Executes a user defined APEX REST API call.
- raw - Send requests to salesforce and have full, raw control over endpoint, parameters, body, etc.
For example, the following producer endpoint uses the upsertSObject API, with the sObjectIdName parameter specifying 'Name' as the external id field. The request message body should be an SObject DTO generated using the maven plugin. The response message will either be null if an existing record was updated, or CreateSObjectResult with an id of the new record, or a list of errors while creating the new object.
...to("salesforce:upsertSObject?sObjectIdName=Name")...54.7.2. Bulk 2.0 API
The Bulk 2.0 API has a simplified model over the original Bulk API. Use it to quickly load a large amount of data into salesforce, or query a large amount of data out of salesforce. Data must be provided in CSV format. The minimum API version for Bulk 2.0 is v41.0. The minimum API version for Bulk Queries is v47.0. DTO classes mentioned below are from the org.apache.camel.component.salesforce.api.dto.bulkv2 package. The following operations are supported:
-
bulk2CreateJob - Create a bulk job. Supply an instance of
Jobin the message body. -
bulk2GetJob - Get an existing Job.
jobIdparameter is required. -
bulk2CreateBatch - Add a Batch of CSV records to a job. Supply CSV data in the message body. The first row must contain headers.
jobIdparameter is required. -
bulk2CloseJob - Close a job. You must close the job in order for it to be processed or aborted/deleted.
jobIdparameter is required. -
bulk2AbortJob - Abort a job.
jobIdparameter is required. -
bulk2DeleteJob - Delete a job.
jobIdparameter is required. -
bulk2GetSuccessfulResults - Get successful results for a job. Returned message body will contain an InputStream of CSV data.
jobIdparameter is required. -
bulk2GetFailedResults - Get failed results for a job. Returned message body will contain an InputStream of CSV data.
jobIdparameter is required. -
bulk2GetUnprocessedRecords - Get unprocessed records for a job. Returned message body will contain an InputStream of CSV data.
jobIdparameter is required. -
bulk2GetAllJobs - Get all jobs. Response body is an instance of
Jobs. If thedoneproperty is false, there are additional pages to fetch, and thenextRecordsUrlproperty contains the value to be set in thequeryLocatorparameter on subsequent calls. -
bulk2CreateQueryJob - Create a bulk query job. Supply an instance of
QueryJobin the message body. -
bulk2GetQueryJob - Get a bulk query job.
jobIdparameter is required. -
bulk2GetQueryJobResults - Get bulk query job results.
jobIdparameter is required. AcceptsmaxRecordsandlocatorparameters. Response message headers includeSforce-NumberOfRecordsandSforce-Locatorheaders. The value ofSforce-Locatorcan be passed into subsequent calls via thelocatorparameter. -
bulk2AbortQueryJob - Abort a bulk query job.
jobIdparameter is required. -
bulk2DeleteQueryJob - Delete a bulk query job.
jobIdparameter is required. -
bulk2GetAllQueryJobs - Get all jobs. Response body is an instance of
QueryJobs. If thedoneproperty is false, there are additional pages to fetch, and thenextRecordsUrlproperty contains the value to be set in thequeryLocatorparameter on subsequent calls.
54.7.3. Rest Bulk (original) API
Producer endpoints can use the following APIs. All Job data formats, i.e. xml, csv, zip/xml, and zip/csv are supported.
The request and response have to be marshalled/unmarshalled by the route. Usually the request will be some stream source like a CSV file,
and the response may also be saved to a file to be correlated with the request.
You can use the following for operationName:
-
createJob - Creates a Salesforce Bulk Job. Must supply a
JobInfoinstance in body. PK Chunking is supported via the pkChunking* options. See an explanation here. - getJob - Gets a Job using its Salesforce Id
- closeJob - Closes a Job
- abortJob - Aborts a Job
- createBatch - Submits a Batch within a Bulk Job
- getBatch - Gets a Batch using Id
- getAllBatches - Gets all Batches for a Bulk Job Id
- getRequest - Gets Request data (XML/CSV) for a Batch
- getResults - Gets the results of the Batch when its complete
- createBatchQuery - Creates a Batch from an SOQL query
- getQueryResultIds - Gets a list of Result Ids for a Batch Query
- getQueryResult - Gets results for a Result Id
- getRecentReports - Gets up to 200 of the reports you most recently viewed by sending a GET request to the Report List resource.
- getReportDescription - Retrieves the report, report type, and related metadata for a report, either in a tabular or summary or matrix format.
- executeSyncReport - Runs a report synchronously with or without changing filters and returns the latest summary data.
- executeAsyncReport - Runs an instance of a report asynchronously with or without filters and returns the summary data with or without details.
- getReportInstances - Returns a list of instances for a report that you requested to be run asynchronously. Each item in the list is treated as a separate instance of the report.
- getReportResults: Contains the results of running a report.
For example, the following producer endpoint uses the createBatch API to create a Job Batch. The in message must contain a body that can be converted into an InputStream (usually UTF-8 CSV or XML content from a file, etc.) and header fields 'jobId' for the Job and 'contentType' for the Job content type, which can be XML, CSV, ZIP_XML or ZIP_CSV. The put message body will contain BatchInfo on success, or throw a SalesforceException on error.
...to("salesforce:createBatch")..54.7.4. Rest Streaming API
Consumer endpoints can use the following syntax for streaming endpoints to receive Salesforce notifications on create/update.
To create and subscribe to a topic
from("salesforce:CamelTestTopic?notifyForFields=ALL¬ifyForOperations=ALL&sObjectName=Merchandise__c&updateTopic=true&sObjectQuery=SELECT Id, Name FROM Merchandise__c")...To subscribe to an existing topic
from("salesforce:CamelTestTopic&sObjectName=Merchandise__c")...54.7.5. Platform events
To emit a platform event use createSObject operation. And set the message body can be JSON string or InputStream with key-value data — in that case sObjectName needs to be set to the API name of the event, or a class that extends from AbstractDTOBase with the appropriate class name for the event.
For example using a DTO:
class Order_Event__e extends AbstractDTOBase {
@JsonProperty("OrderNumber")
private String orderNumber;
// ... other properties and getters/setters
}
from("timer:tick")
.process(exchange -> {
final Message in = exchange.getIn();
String orderNumber = "ORD" + exchange.getProperty(Exchange.TIMER_COUNTER);
Order_Event__e event = new Order_Event__e();
event.setOrderNumber(orderNumber);
in.setBody(event);
})
.to("salesforce:createSObject");Or using JSON event data:
from("timer:tick")
.process(exchange -> {
final Message in = exchange.getIn();
String orderNumber = "ORD" + exchange.getProperty(Exchange.TIMER_COUNTER);
in.setBody("{\"OrderNumber\":\"" + orderNumber + "\"}");
})
.to("salesforce:createSObject?sObjectName=Order_Event__e");
To receive platform events use the consumer endpoint with the API name of the platform event prefixed with event/ (or /event/), e.g.: salesforce:events/Order_Event__e. Processor consuming from that endpoint will receive either org.apache.camel.component.salesforce.api.dto.PlatformEvent object or org.cometd.bayeux.Message in the body depending on the rawPayload being false or true respectively.
For example, in the simplest form to consume one event:
PlatformEvent event = consumer.receiveBody("salesforce:event/Order_Event__e", PlatformEvent.class);54.7.6. Change data capture events
On the one hand, Salesforce could be configured to emit notifications for record changes of select objects. On the other hand, the Camel Salesforce component could react to such notifications, allowing for instance to synchronize those changes into an external system.
The notifications of interest could be specified in the from("salesforce:XXX") clause of a Camel route via the subscription channel, e.g:
from("salesforce:data/ChangeEvents?replayId=-1").log("being notified of all change events")
from("salesforce:data/AccountChangeEvent?replayId=-1").log("being notified of change events for Account records")
from("salesforce:data/Employee__ChangeEvent?replayId=-1").log("being notified of change events for Employee__c custom object")
The received message contains either java.util.Map<String,Object> or org.cometd.bayeux.Message in the body depending on the rawPayload being false or true respectively. The CamelSalesforceChangeType header could be valued to one of CREATE, UPDATE, DELETE or UNDELETE.
More details about how to use the Camel Salesforce component change data capture capabilities could be found in the ChangeEventsConsumerIntegrationTest.
The Salesforce developer guide is a good fit to better know the subtleties of implementing a change data capture integration application. The dynamic nature of change event body fields, high level replication steps as well as security considerations could be of interest.
54.8. Examples
54.8.1. Uploading a document to a ContentWorkspace
Create the ContentVersion in Java, using a Processor instance:
public class ContentProcessor implements Processor {
public void process(Exchange exchange) throws Exception {
Message message = exchange.getIn();
ContentVersion cv = new ContentVersion();
ContentWorkspace cw = getWorkspace(exchange);
cv.setFirstPublishLocationId(cw.getId());
cv.setTitle("test document");
cv.setPathOnClient("test_doc.html");
byte[] document = message.getBody(byte[].class);
ObjectMapper mapper = new ObjectMapper();
String enc = mapper.convertValue(document, String.class);
cv.setVersionDataUrl(enc);
message.setBody(cv);
}
protected ContentWorkspace getWorkSpace(Exchange exchange) {
// Look up the content workspace somehow, maybe use enrich() to add it to a
// header that can be extracted here
----
}
}Give the output from the processor to the Salesforce component:
from("file:///home/camel/library")
.to(new ContentProcessor()) // convert bytes from the file into a ContentVersion SObject
// for the salesforce component
.to("salesforce:createSObject");54.9. Using Salesforce Limits API
With salesforce:limits operation you can fetch of API limits from Salesforce and then act upon that data received. The result of salesforce:limits operation is mapped to org.apache.camel.component.salesforce.api.dto.Limits class and can be used in a custom processors or expressions.
For instance, consider that you need to limit the API usage of Salesforce so that 10% of daily API requests is left for other routes. The body of output message contains an instance of org.apache.camel.component.salesforce.api.dto.Limits object that can be used in conjunction with Content Based Router and Content Based Router and Spring Expression Language (SpEL) to choose when to perform queries.
Notice how multiplying 1.0 with the integer value held in body.dailyApiRequests.remaining makes the expression evaluate as with floating point arithmetic, without it - it would end up making integral division which would result with either 0 (some API limits consumed) or 1 (no API limits consumed).
from("direct:querySalesforce")
.to("salesforce:limits")
.choice()
.when(spel("#{1.0 * body.dailyApiRequests.remaining / body.dailyApiRequests.max < 0.1}"))
.to("salesforce:query?...")
.otherwise()
.setBody(constant("Used up Salesforce API limits, leaving 10% for critical routes"))
.endChoice()54.10. Working with approvals
All the properties are named exactly the same as in the Salesforce REST API prefixed with approval.. You can set approval properties by setting approval.PropertyName of the Endpoint these will be used as template — meaning that any property not present in either body or header will be taken from the Endpoint configuration. Or you can set the approval template on the Endpoint by assigning approval property to a reference onto a bean in the Registry.
You can also provide header values using the same approval.PropertyName in the incoming message headers.
And finally body can contain one AprovalRequest or an Iterable of ApprovalRequest objects to process as a batch.
The important thing to remember is the priority of the values specified in these three mechanisms:
- value in body takes precedence before any other
- value in message header takes precedence before template value
- value in template is set if no other value in header or body was given
For example to send one record for approval using values in headers use:
Given a route:
from("direct:example1")//
.setHeader("approval.ContextId", simple("${body['contextId']}"))
.setHeader("approval.NextApproverIds", simple("${body['nextApproverIds']}"))
.to("salesforce:approval?"//
+ "approval.actionType=Submit"//
+ "&approval.comments=this is a test"//
+ "&approval.processDefinitionNameOrId=Test_Account_Process"//
+ "&approval.skipEntryCriteria=true");You could send a record for approval using:
final Map<String, String> body = new HashMap<>();
body.put("contextId", accountIds.iterator().next());
body.put("nextApproverIds", userId);
final ApprovalResult result = template.requestBody("direct:example1", body, ApprovalResult.class);54.11. Using Salesforce Recent Items API
To fetch the recent items use salesforce:recent operation. This operation returns an java.util.List of org.apache.camel.component.salesforce.api.dto.RecentItem objects (List<RecentItem>) that in turn contain the Id, Name and Attributes (with type and url properties). You can limit the number of returned items by specifying limit parameter set to maximum number of records to return. For example:
from("direct:fetchRecentItems")
to("salesforce:recent")
.split().body()
.log("${body.name} at ${body.attributes.url}");54.12. Using Salesforce Composite API to submit SObject tree
To create up to 200 records including parent-child relationships use salesforce:composite-tree operation. This requires an instance of org.apache.camel.component.salesforce.api.dto.composite.SObjectTree in the input message and returns the same tree of objects in the output message. The org.apache.camel.component.salesforce.api.dto.AbstractSObjectBase instances within the tree get updated with the identifier values (Id property) or their corresponding org.apache.camel.component.salesforce.api.dto.composite.SObjectNode is populated with errors on failure.
Note that for some records operation can succeed and for some it can fail — so you need to manually check for errors.
Easiest way to use this functionality is to use the DTOs generated by the camel-salesforce-maven-plugin, but you also have the option of customizing the references that identify the each object in the tree, for instance primary keys from your database.
Lets look at an example:
Account account = ...
Contact president = ...
Contact marketing = ...
Account anotherAccount = ...
Contact sales = ...
Asset someAsset = ...
// build the tree
SObjectTree request = new SObjectTree();
request.addObject(account).addChildren(president, marketing);
request.addObject(anotherAccount).addChild(sales).addChild(someAsset);
final SObjectTree response = template.requestBody("salesforce:composite-tree", tree, SObjectTree.class);
final Map<Boolean, List<SObjectNode>> result = response.allNodes()
.collect(Collectors.groupingBy(SObjectNode::hasErrors));
final List<SObjectNode> withErrors = result.get(true);
final List<SObjectNode> succeeded = result.get(false);
final String firstId = succeeded.get(0).getId();54.13. Using Salesforce Composite API to submit multiple requests in a batch
The Composite API batch operation (composite-batch) allows you to accumulate multiple requests in a batch and then submit them in one go, saving the round trip cost of multiple individual requests. Each response is then received in a list of responses with the order preserved, so that the n-th requests response is in the n-th place of the response.
The results can vary from API to API so the result of the request is given as a java.lang.Object. In most cases the result will be a java.util.Map with string keys and values or other java.util.Map as value. Requests are made in JSON format and hold some type information (i.e. it is known what values are strings and what values are numbers).
Lets look at an example:
final String acountId = ...
final SObjectBatch batch = new SObjectBatch("38.0");
final Account updates = new Account();
updates.setName("NewName");
batch.addUpdate("Account", accountId, updates);
final Account newAccount = new Account();
newAccount.setName("Account created from Composite batch API");
batch.addCreate(newAccount);
batch.addGet("Account", accountId, "Name", "BillingPostalCode");
batch.addDelete("Account", accountId);
final SObjectBatchResponse response = template.requestBody("salesforce:composite-batch", batch, SObjectBatchResponse.class);
boolean hasErrors = response.hasErrors(); // if any of the requests has resulted in either 4xx or 5xx HTTP status
final List<SObjectBatchResult> results = response.getResults(); // results of three operations sent in batch
final SObjectBatchResult updateResult = results.get(0); // update result
final int updateStatus = updateResult.getStatusCode(); // probably 204
final Object updateResultData = updateResult.getResult(); // probably null
final SObjectBatchResult createResult = results.get(1); // create result
@SuppressWarnings("unchecked")
final Map<String, Object> createData = (Map<String, Object>) createResult.getResult();
final String newAccountId = createData.get("id"); // id of the new account, this is for JSON, for XML it would be createData.get("Result").get("id")
final SObjectBatchResult retrieveResult = results.get(2); // retrieve result
@SuppressWarnings("unchecked")
final Map<String, Object> retrieveData = (Map<String, Object>) retrieveResult.getResult();
final String accountName = retrieveData.get("Name"); // Name of the retrieved account, this is for JSON, for XML it would be createData.get("Account").get("Name")
final String accountBillingPostalCode = retrieveData.get("BillingPostalCode"); // Name of the retrieved account, this is for JSON, for XML it would be createData.get("Account").get("BillingPostalCode")
final SObjectBatchResult deleteResult = results.get(3); // delete result
final int updateStatus = deleteResult.getStatusCode(); // probably 204
final Object updateResultData = deleteResult.getResult(); // probably null54.14. Using Salesforce Composite API to submit multiple chained requests
The composite operation allows submitting up to 25 requests that can be chained together, for instance identifier generated in previous request can be used in subsequent request. Individual requests and responses are linked with the provided reference.
Composite API supports only JSON payloads.
As with the batch API the results can vary from API to API so the result of the request is given as a java.lang.Object. In most cases the result will be a java.util.Map with string keys and values or other java.util.Map as value. Requests are made in JSON format hold some type information (i.e. it is known what values are strings and what values are numbers).
Lets look at an example:
SObjectComposite composite = new SObjectComposite("38.0", true);
// first insert operation via an external id
final Account updateAccount = new TestAccount();
updateAccount.setName("Salesforce");
updateAccount.setBillingStreet("Landmark @ 1 Market Street");
updateAccount.setBillingCity("San Francisco");
updateAccount.setBillingState("California");
updateAccount.setIndustry(Account_IndustryEnum.TECHNOLOGY);
composite.addUpdate("Account", "001xx000003DIpcAAG", updateAccount, "UpdatedAccount");
final Contact newContact = new TestContact();
newContact.setLastName("John Doe");
newContact.setPhone("1234567890");
composite.addCreate(newContact, "NewContact");
final AccountContactJunction__c junction = new AccountContactJunction__c();
junction.setAccount__c("001xx000003DIpcAAG");
junction.setContactId__c("@{NewContact.id}");
composite.addCreate(junction, "JunctionRecord");
final SObjectCompositeResponse response = template.requestBody("salesforce:composite", composite, SObjectCompositeResponse.class);
final List<SObjectCompositeResult> results = response.getCompositeResponse();
final SObjectCompositeResult accountUpdateResult = results.stream().filter(r -> "UpdatedAccount".equals(r.getReferenceId())).findFirst().get()
final int statusCode = accountUpdateResult.getHttpStatusCode(); // should be 200
final Map<String, ?> accountUpdateBody = accountUpdateResult.getBody();
final SObjectCompositeResult contactCreationResult = results.stream().filter(r -> "JunctionRecord".equals(r.getReferenceId())).findFirst().get()54.15. Using "raw" Salesforce composite
It’s possible to directly call Salesforce composite by preparing the Salesforce JSON request in the route thanks to the rawPayload option.
For instance, you can have the following route:
from("timer:fire?period=2000").setBody(constant("{\n" +
" \"allOrNone\" : true,\n" +
" \"records\" : [ { \n" +
" \"attributes\" : {\"type\" : \"FOO\"},\n" +
" \"Name\" : \"123456789\",\n" +
" \"FOO\" : \"XXXX\",\n" +
" \"ACCOUNT\" : 2100.0\n" +
" \"ExternalID\" : \"EXTERNAL\"\n"
" }]\n" +
"}")
.to("salesforce:composite?rawPayload=true")
.log("${body}");
The route directly creates the body as JSON and directly submit to salesforce endpoint using rawPayload=true option.
With this approach, you have the complete control on the Salesforce request.
POST is the default HTTP method used to send raw Composite requests to salesforce. Use the compositeMethod option to override to the other supported value, GET, which returns a list of other available composite resources.
54.16. Using Raw Operation
Send HTTP requests to salesforce with full, raw control of all aspects of the call. Any serialization or deserialization of request and response bodies must be performed in the route. The Content-Type HTTP header will be automatically set based on the format option, but this can be overridden with the rawHttpHeaders option.
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
| request body |
| Body of the HTTP request | ||
| rawPath |
| The portion of the endpoint URL after the domain name, e.g., '/services/data/v51.0/sobjects/Account/' | x | |
| rawMethod |
| The HTTP method | x | |
| rawQueryParameters |
| Comma separated list of message headers to include as query parameters. Do not url-encode values as this will be done automatically. | ||
| rawHttpHeaders |
| Comma separated list of message headers to include as HTTP headers |
54.16.1. Query example
In this example we’ll send a query to the REST API. The query must be passed in a URL parameter called "q", so we’ll create a message header called q and tell the raw operation to include that message header as a URL parameter:
from("direct:queryExample")
.setHeader("q", "SELECT Id, LastName FROM Contact")
.to("salesforce:raw?format=JSON&rawMethod=GET&rawQueryParameters=q&rawPath=/services/data/v51.0/query")
// deserialize JSON results or handle in some other way54.16.2. SObject example
In this example, we’ll pass a Contact the REST API in a create operation. Since the raw operation does not perform any serialization, we make sure to pass XML in the message body
from("direct:createAContact")
.setBody(constant("<Contact><LastName>TestLast</LastName></Contact>"))
.to("salesforce:raw?format=XML&rawMethod=POST&rawPath=/services/data/v51.0/sobjects/Contact")The response is:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Result>
<id>0034x00000RnV6zAAF</id>
<success>true</success>
</Result>54.17. Using Composite SObject Collections
The SObject Collections API executes actions on multiple records in one request. Use sObject Collections to reduce the number of round-trips between the client and server. The entire request counts as a single call toward your API limits. This resource is available in API version 42.0 and later. SObject records (aka DTOs) supplied to these operations must be instances of subclasses of AbstractDescribedSObjectBase. See the Maven Plugin section for information on generating these DTO classes. These operations serialize supplied DTOs to JSON.
54.17.1. compositeRetrieveSObjectCollections
Retrieve one or more records of the same object type.
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
| ids | List of String or comma-separated string | A list of one or more IDs of the objects to return. All IDs must belong to the same object type. | x | |
| fields | List of String or comma-separated string | A list of fields to include in the response. The field names you specify must be valid, and you must have read-level permissions to each field. | x | |
| sObjectName | String |
Type of SObject, e.g. | x | |
| sObjectClass | String | Fully-qualified class name of DTO class to use for deserializing the response. |
Required if |
54.17.2. compositeCreateSObjectCollections
Add up to 200 records, returning a list of SaveSObjectResult objects. Mixed SObject types is supported.
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
| request body |
List of | A list of SObjects to create | x | |
| allOrNone | boolean | Indicates whether to roll back the entire request when the creation of any object fails (true) or to continue with the independent creation of other objects in the request. | false |
54.17.3. compositeUpdateSObjectCollections
Update up to 200 records, returning a list of SaveSObjectResult objects. Mixed SObject types is supported.
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
| request body |
List of | A list of SObjects to update | x | |
| allOrNone | boolean | Indicates whether to roll back the entire request when the update of any object fails (true) or to continue with the independent update of other objects in the request. | false |
54.17.4. compositeUpsertSObjectCollections
Create or update (upsert) up to 200 records based on an external ID field, returning a list of UpsertSObjectResult objects. Mixed SObject types is not supported.
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
| request body |
List of | A list of SObjects to upsert | x | |
| allOrNone | boolean | Indicates whether to roll back the entire request when the upsert of any object fails (true) or to continue with the independent upsert of other objects in the request. | false | |
| sObjectName | String |
Type of SObject, e.g. | x | |
| sObjectIdName | String | Name of External ID field | x |
54.17.5. compositeDeleteSObjectCollections
Delete up to 200 records, returning a list of DeleteSObjectResult objects. Mixed SObject types is supported.
| Parameter | Type | Description | Default | Required |
|---|---|---|---|---|
|
| List of String or comma-separated string | A list of up to 200 IDs of objects to be deleted. | x | |
|
| boolean | Indicates whether to roll back the entire request when the deletion of any object fails (true) or to continue with the independent deletion of other objects in the request. | false |
54.18. Sending null values to salesforce
By default, SObject fields with null values are not sent to salesforce. In order to send null values to salesforce, use the fieldsToNull property, as follows:
accountSObject.getFieldsToNull().add("Site");54.19. Generating SOQL query strings
org.apache.camel.component.salesforce.api.utils.QueryHelper contains helper methods to generate SOQL queries. For instance to fetch all custom fields from Account SObject you can simply generate the SOQL SELECT by invoking:
String allCustomFieldsQuery = QueryHelper.queryToFetchFilteredFieldsOf(new Account(), SObjectField::isCustom);
54.20. Camel Salesforce Maven Plugin
This Maven plugin generates DTOs for the Camel.
For obvious security reasons it is recommended that the clientId, clientSecret, userName and password fields be not set in the pom.xml. The plugin should be configured for the rest of the properties, and can be executed using the following command:
mvn camel-salesforce:generate -DcamelSalesforce.clientId=<clientid> -DcamelSalesforce.clientSecret=<clientsecret> \
-DcamelSalesforce.userName=<username> -DcamelSalesforce.password=<password>
The generated DTOs use Jackson annotations. All Salesforce field types are supported. Date and time fields are mapped to java.time.ZonedDateTime by default, and picklist fields are mapped to generated Java Enumerations.
Please refer to README.md for details on how to generate the DTO.
54.21. Spring Boot Auto-Configuration
When using salesforce with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-salesforce-starter</artifactId> </dependency>
The component supports 91 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.salesforce.all-or-none | Composite API option to indicate to rollback all records if any are not successful. | false | Boolean |
| camel.component.salesforce.apex-method | APEX method name. | String | |
| camel.component.salesforce.apex-query-params | Query params for APEX method. | Map | |
| camel.component.salesforce.apex-url | APEX method URL. | String | |
| camel.component.salesforce.api-version | Salesforce API version. | 53.0 | String |
| camel.component.salesforce.authentication-type | Explicit authentication method to be used, one of USERNAME_PASSWORD, REFRESH_TOKEN or JWT. Salesforce component can auto-determine the authentication method to use from the properties set, set this property to eliminate any ambiguity. | AuthenticationType | |
| camel.component.salesforce.autowired-enabled | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean |
| camel.component.salesforce.backoff-increment | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. The option is a long type. | 1000 | Long |
| camel.component.salesforce.batch-id | Bulk API Batch ID. | String | |
| camel.component.salesforce.bridge-error-handler | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | Boolean |
| camel.component.salesforce.client-id | OAuth Consumer Key of the connected app configured in the Salesforce instance setup. Typically a connected app needs to be configured but one can be provided by installing a package. | String | |
| camel.component.salesforce.client-secret | OAuth Consumer Secret of the connected app configured in the Salesforce instance setup. | String | |
| camel.component.salesforce.composite-method | Composite (raw) method. | String | |
| camel.component.salesforce.config | Global endpoint configuration - use to set values that are common to all endpoints. The option is a org.apache.camel.component.salesforce.SalesforceEndpointConfig type. | SalesforceEndpointConfig | |
| camel.component.salesforce.content-type | Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV. | ContentType | |
| camel.component.salesforce.default-replay-id | Default replayId setting if no value is found in initialReplayIdMap. | -1 | Long |
| camel.component.salesforce.enabled | Whether to enable auto configuration of the salesforce component. This is enabled by default. | Boolean | |
| camel.component.salesforce.fall-back-replay-id | ReplayId to fall back to after an Invalid Replay Id response. | -1 | Long |
| camel.component.salesforce.format | Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON. As of Camel 3.12, this option only applies to the Raw operation. | PayloadFormat | |
| camel.component.salesforce.http-client | Custom Jetty Http Client to use to connect to Salesforce. The option is a org.apache.camel.component.salesforce.SalesforceHttpClient type. | SalesforceHttpClient | |
| camel.component.salesforce.http-client-connection-timeout | Connection timeout used by the HttpClient when connecting to the Salesforce server. | 60000 | Long |
| camel.component.salesforce.http-client-idle-timeout | Timeout used by the HttpClient when waiting for response from the Salesforce server. | 10000 | Long |
| camel.component.salesforce.http-client-properties | Used to set any properties that can be configured on the underlying HTTP client. Have a look at properties of SalesforceHttpClient and the Jetty HttpClient for all available options. | Map | |
| camel.component.salesforce.http-max-content-length | Max content length of an HTTP response. | Integer | |
| camel.component.salesforce.http-proxy-auth-uri | Used in authentication against the HTTP proxy server, needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication. | String | |
| camel.component.salesforce.http-proxy-excluded-addresses | A list of addresses for which HTTP proxy server should not be used. | Set | |
| camel.component.salesforce.http-proxy-host | Hostname of the HTTP proxy server to use. | String | |
| camel.component.salesforce.http-proxy-included-addresses | A list of addresses for which HTTP proxy server should be used. | Set | |
| camel.component.salesforce.http-proxy-password | Password to use to authenticate against the HTTP proxy server. | String | |
| camel.component.salesforce.http-proxy-port | Port number of the HTTP proxy server to use. | Integer | |
| camel.component.salesforce.http-proxy-realm | Realm of the proxy server, used in preemptive Basic/Digest authentication methods against the HTTP proxy server. | String | |
| camel.component.salesforce.http-proxy-secure | If set to false disables the use of TLS when accessing the HTTP proxy. | true | Boolean |
| camel.component.salesforce.http-proxy-socks4 | If set to true the configures the HTTP proxy to use as a SOCKS4 proxy. | false | Boolean |
| camel.component.salesforce.http-proxy-use-digest-auth | If set to true Digest authentication will be used when authenticating to the HTTP proxy, otherwise Basic authorization method will be used. | false | Boolean |
| camel.component.salesforce.http-proxy-username | Username to use to authenticate against the HTTP proxy server. | String | |
| camel.component.salesforce.http-request-buffer-size | HTTP request buffer size. May need to be increased for large SOQL queries. | 8192 | Integer |
| camel.component.salesforce.include-details | Include details in Salesforce1 Analytics report, defaults to false. | Boolean | |
| camel.component.salesforce.initial-replay-id-map | Replay IDs to start from per channel name. | Map | |
| camel.component.salesforce.instance-id | Salesforce1 Analytics report execution instance ID. | String | |
| camel.component.salesforce.instance-url | URL of the Salesforce instance used after authentication, by default received from Salesforce on successful authentication. | String | |
| camel.component.salesforce.job-id | Bulk API Job ID. | String | |
| camel.component.salesforce.jwt-audience | Value to use for the Audience claim (aud) when using OAuth JWT flow. If not set, the login URL will be used, which is appropriate in most cases. | String | |
| camel.component.salesforce.keystore | KeyStore parameters to use in OAuth JWT flow. The KeyStore should contain only one entry with private key and certificate. Salesforce does not verify the certificate chain, so this can easily be a selfsigned certificate. Make sure that you upload the certificate to the corresponding connected app. The option is a org.apache.camel.support.jsse.KeyStoreParameters type. | KeyStoreParameters | |
| camel.component.salesforce.lazy-login | If set to true prevents the component from authenticating to Salesforce with the start of the component. You would generally set this to the (default) false and authenticate early and be immediately aware of any authentication issues. | false | Boolean |
| camel.component.salesforce.lazy-start-producer | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | Boolean |
| camel.component.salesforce.limit | Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation. | Integer | |
| camel.component.salesforce.locator | Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job. | String | |
| camel.component.salesforce.login-config | All authentication configuration in one nested bean, all properties set there can be set directly on the component as well. The option is a org.apache.camel.component.salesforce.SalesforceLoginConfig type. | SalesforceLoginConfig | |
| camel.component.salesforce.login-url | URL of the Salesforce instance used for authentication, by default set to . | String | |
| camel.component.salesforce.long-polling-transport-properties | Used to set any properties that can be configured on the LongPollingTransport used by the BayeuxClient (CometD) used by the streaming api. | Map | |
| camel.component.salesforce.max-backoff | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. The option is a long type. | 30000 | Long |
| camel.component.salesforce.max-records | The maximum number of records to retrieve per set of results for a Bulk 2.0 Query. The request is still subject to the size limits. If you are working with a very large number of query results, you may experience a timeout before receiving all the data from Salesforce. To prevent a timeout, specify the maximum number of records your client is expecting to receive in the maxRecords parameter. This splits the results into smaller sets with this value as the maximum size. | Integer | |
| camel.component.salesforce.not-found-behaviour | Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL NotFoundBehaviour#NULL or should a exception be signaled on the exchange NotFoundBehaviour#EXCEPTION - the default. | NotFoundBehaviour | |
| camel.component.salesforce.notify-for-fields | Notify for fields, options are ALL, REFERENCED, SELECT, WHERE. | NotifyForFieldsEnum | |
| camel.component.salesforce.notify-for-operation-create | Notify for create operation, defaults to false (API version = 29.0). | Boolean | |
| camel.component.salesforce.notify-for-operation-delete | Notify for delete operation, defaults to false (API version = 29.0). | Boolean | |
| camel.component.salesforce.notify-for-operation-undelete | Notify for un-delete operation, defaults to false (API version = 29.0). | Boolean | |
| camel.component.salesforce.notify-for-operation-update | Notify for update operation, defaults to false (API version = 29.0). | Boolean | |
| camel.component.salesforce.notify-for-operations | Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version 29.0). | NotifyForOperationsEnum | |
| camel.component.salesforce.object-mapper | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. The option is a com.fasterxml.jackson.databind.ObjectMapper type. | ObjectMapper | |
| camel.component.salesforce.packages | In what packages are the generated DTO classes. Typically the classes would be generated using camel-salesforce-maven-plugin. Set it if using the generated DTOs to gain the benefit of using short SObject names in parameters/header values. Multiple packages can be separated by comma. | String | |
| camel.component.salesforce.password | Password used in OAuth flow to gain access to access token. It’s easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. Make sure that you append security token to the end of the password if using one. | String | |
| camel.component.salesforce.pk-chunking | Use PK Chunking. Only for use in original Bulk API. Bulk 2.0 API performs PK chunking automatically, if necessary. | Boolean | |
| camel.component.salesforce.pk-chunking-chunk-size | Chunk size for use with PK Chunking. If unspecified, salesforce default is 100,000. Maximum size is 250,000. | Integer | |
| camel.component.salesforce.pk-chunking-parent | Specifies the parent object when you’re enabling PK chunking for queries on sharing objects. The chunks are based on the parent object’s records rather than the sharing object’s records. For example, when querying on AccountShare, specify Account as the parent object. PK chunking is supported for sharing objects as long as the parent object is supported. | String | |
| camel.component.salesforce.pk-chunking-start-row | Specifies the 15-character or 18-character record ID to be used as the lower boundary for the first chunk. Use this parameter to specify a starting ID when restarting a job that failed between batches. | String | |
| camel.component.salesforce.query-locator | Query Locator provided by salesforce for use when a query results in more records than can be retrieved in a single call. Use this value in a subsequent call to retrieve additional records. | String | |
| camel.component.salesforce.raw-http-headers | Comma separated list of message headers to include as HTTP parameters for Raw operation. | String | |
| camel.component.salesforce.raw-method | HTTP method to use for the Raw operation. | String | |
| camel.component.salesforce.raw-path | The portion of the endpoint URL after the domain name. E.g., '/services/data/v52.0/sobjects/Account/'. | String | |
| camel.component.salesforce.raw-payload | Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default. | false | Boolean |
| camel.component.salesforce.raw-query-parameters | Comma separated list of message headers to include as query parameters for Raw operation. Do not url-encode values as this will be done automatically. | String | |
| camel.component.salesforce.refresh-token | Refresh token already obtained in the refresh token OAuth flow. One needs to setup a web application and configure a callback URL to receive the refresh token, or configure using the builtin callback at and then retrive the refresh_token from the URL at the end of the flow. Note that in development organizations Salesforce allows hosting the callback web application at localhost. | String | |
| camel.component.salesforce.report-id | Salesforce1 Analytics report Id. | String | |
| camel.component.salesforce.report-metadata | Salesforce1 Analytics report metadata for filtering. The option is a org.apache.camel.component.salesforce.api.dto.analytics.reports.ReportMetadata type. | ReportMetadata | |
| camel.component.salesforce.result-id | Bulk API Result ID. | String | |
| camel.component.salesforce.s-object-blob-field-name | SObject blob field name. | String | |
| camel.component.salesforce.s-object-class | Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin. | String | |
| camel.component.salesforce.s-object-fields | SObject fields to retrieve. | String | |
| camel.component.salesforce.s-object-id | SObject ID if required by API. | String | |
| camel.component.salesforce.s-object-id-name | SObject external ID field name. | String | |
| camel.component.salesforce.s-object-id-value | SObject external ID field value. | String | |
| camel.component.salesforce.s-object-name | SObject name if required or supported by API. | String | |
| camel.component.salesforce.s-object-query | Salesforce SOQL query string. | String | |
| camel.component.salesforce.s-object-search | Salesforce SOSL search string. | String | |
| camel.component.salesforce.ssl-context-parameters | SSL parameters to use, see SSLContextParameters class for all available options. The option is a org.apache.camel.support.jsse.SSLContextParameters type. | SSLContextParameters | |
| camel.component.salesforce.update-topic | Whether to update an existing Push Topic when using the Streaming API, defaults to false. | false | Boolean |
| camel.component.salesforce.use-global-ssl-context-parameters | Enable usage of global SSL context parameters. | false | Boolean |
| camel.component.salesforce.user-name | Username used in OAuth flow to gain access to access token. It’s easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. | String | |
| camel.component.salesforce.worker-pool-max-size | Maximum size of the thread pool used to handle HTTP responses. | 20 | Integer |
| camel.component.salesforce.worker-pool-size | Size of the thread pool used to handle HTTP responses. | 10 | Integer |
