Salesforce

Communicate with Salesforce using Java DTOs.

Metadata

Property	Value
Scheme	`salesforce`
Support Level	Stable
Labels	cloud,saas
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-salesforce</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`operationName`	object	✓		The operation to use
`topicName`	string			The name of the topic/channel to use
`apexMethod`	string			APEX method name
`apexQueryParams`	object			Query params for APEX method
`apiVersion`	string		`56.0`	Salesforce API version.
`backoffIncrement`	duration		`1000`	Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
`batchId`	string			Bulk API Batch ID
`contentType`	object			Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV
`defaultReplayId`	integer		`-1`	Default replayId setting if no value is found in initialReplayIdMap
`fallBackReplayId`	integer		`-1`	ReplayId to fall back to after an Invalid Replay Id response
`format`	object			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.
`httpClient`	object			Custom Jetty Http Client to use to connect to Salesforce.
`includeDetails`	boolean			Include details in Salesforce1 Analytics report, defaults to false.
`initialReplayIdMap`	object			Replay IDs to start from per channel name.
`instanceId`	string			Salesforce1 Analytics report execution instance ID
`jobId`	string			Bulk API Job ID
`limit`	integer			Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation.
`locator`	string			Locator provided by salesforce Bulk 2.0 API for use in getting results for a Query job.
`maxBackoff`	duration		`30000`	Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
`maxRecords`	integer			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.
`notFoundBehaviour`	object		`EXCEPTION`	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.
`notifyForFields`	object			Notify for fields, options are ALL, REFERENCED, SELECT, WHERE
`notifyForOperationCreate`	boolean			Notify for create operation, defaults to false (API version >= 29.0)
`notifyForOperationDelete`	boolean			Notify for delete operation, defaults to false (API version >= 29.0)
`notifyForOperations`	object			Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0)
`notifyForOperationUndelete`	boolean			Notify for un-delete operation, defaults to false (API version >= 29.0)
`notifyForOperationUpdate`	boolean			Notify for update operation, defaults to false (API version >= 29.0)
`objectMapper`	object			Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.
`pkChunking`	boolean			Use PK Chunking. Only for use in original Bulk API. Bulk 2.0 API performs PK chunking automatically, if necessary.
`pkChunkingChunkSize`	integer			Chunk size for use with PK Chunking. If unspecified, salesforce default is 100,000. Maximum size is 250,000.
`pkChunkingParent`	string			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.
`pkChunkingStartRow`	string			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.
`queryLocator`	string			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.
`rawPayload`	boolean		`false`	Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default
`reportId`	string			Salesforce1 Analytics report Id
`reportMetadata`	object			Salesforce1 Analytics report metadata for filtering
`resultId`	string			Bulk API Result ID
`sObjectBlobFieldName`	string			SObject blob field name
`sObjectClass`	string			Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin
`sObjectFields`	string			SObject fields to retrieve
`sObjectId`	string			SObject ID if required by API
`sObjectIdName`	string			SObject external ID field name
`sObjectIdValue`	string			SObject external ID field value
`sObjectName`	string			SObject name if required or supported by API
`sObjectQuery`	string			Salesforce SOQL query string
`sObjectSearch`	string			Salesforce SOSL search string
`streamQueryResult`	boolean		`false`	If true, streams SOQL query result and transparently handles subsequent requests if there are multiple pages. Otherwise, results are returned one page at a time.
`updateTopic`	boolean		`false`	Whether to update an existing Push Topic when using the Streaming API, defaults to false
`pubSubBatchSize`	integer		`100`	Max number of events to receive in a batch from the Pub/Sub API.
`pubSubDeserializeType`	object		`AVRO`	How to deserialize events consume from the Pub/Sub API. AVRO will try a SpecificRecord subclass if found, otherwise GenericRecord.
`pubSubPojoClass`	string			Fully qualified class name to deserialize Pub/Sub API event to.
`pubSubReplayId`	string			The replayId value to use when subscribing to the Pub/Sub API.
`replayId`	integer			The replayId value to use when subscribing to the Streaming API.
`replayPreset`	object		`LATEST`	Replay preset for Pub/Sub API.
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.
`exceptionHandler`	object			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.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`allOrNone`	boolean		`false`	Composite API option to indicate to rollback all records if any are not successful.
`apexUrl`	string			APEX method URL
`compositeMethod`	string			Composite (raw) method.
`eventName`	string			Name of Platform Event, Change Data Capture Event, custom event, etc.
`eventSchemaFormat`	object			EXPANDED: Apache Avro format but doesn't strictly adhere to the record complex type. COMPACT: Apache Avro, adheres to the specification for the record complex type. This parameter is available in API version 43.0 and later.
`eventSchemaId`	string			The ID of the event schema.
`rawHttpHeaders`	string			Comma separated list of message headers to include as HTTP parameters for Raw operation.
`rawMethod`	string			HTTP method to use for the Raw operation
`rawPath`	string			The portion of the endpoint URL after the domain name. E.g., '/services/data/v52.0/sobjects/Account/'
`rawQueryParameters`	string			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.
`lazyStartProducer`	boolean		`false`	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.