Salesforce Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive updates from Salesforce.

Configuration Options

The following table summarizes the configuration options available for the salesforce-source Kamelet:

Property	Name	Description	Type	Default	Example
clientId	Consumer Key	Required The Salesforce application consumer key.	string
clientSecret	Consumer Secret	Required The Salesforce application consumer secret.	string
password	Password	Required The Salesforce user password.	string
query	Query	Required The query to execute on Salesforce.	string		SELECT Id, Name, Email, Phone FROM Contact
topicName	Topic Name	Required The name of the topic or channel.	string		ContactTopic
userName	Username	Required The Salesforce username.	string
loginUrl	Login URL	The Salesforce instance login URL.	string	https://login.salesforce.com
notifyForFields	Notify For Fields	Notify for fields. Enum values: * ALL * REFERENCED * SELECT * WHERE	string	ALL
notifyForOperationCreate	Notify Operation Create	Notify for create operation.	boolean	true
notifyForOperationDelete	Notify Operation Delete	Notify for delete operation.	boolean	false
notifyForOperationUndelete	Notify Operation Undelete	Notify for undelete operation.	boolean	false
notifyForOperationUpdate	Notify Operation Update	Notify for update operation.	boolean	false
operation	Operation	The operation to use.	string	subscribe
rawPayload	Raw Payload	Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default.	boolean	false
replayId	Replay Id	The replayId value to use when subscribing to the Streaming API.	long

Property

Name

Description

Type

Default

Example

clientId

Consumer Key

Required The Salesforce application consumer key.

string

clientSecret

Consumer Secret

Required The Salesforce application consumer secret.

string

password

Password

Required The Salesforce user password.

string

query

Query

Required The query to execute on Salesforce.

string

SELECT Id, Name, Email, Phone FROM Contact

topicName

Topic Name

Required The name of the topic or channel.

string

ContactTopic

userName

Username

Required The Salesforce username.

string

loginUrl

The Salesforce instance login URL.

string

https://login.salesforce.com

notifyForFields

Notify For Fields

Notify for fields.

Enum values:

* ALL * REFERENCED * SELECT * WHERE

string

ALL

notifyForOperationCreate

Notify Operation Create

Notify for create operation.

boolean

true

notifyForOperationDelete

Notify Operation Delete

Notify for delete operation.

boolean

false

notifyForOperationUndelete

Notify Operation Undelete

Notify for undelete operation.

boolean

false

notifyForOperationUpdate

Notify Operation Update

Notify for update operation.

boolean

false

operation

Operation

The operation to use.

string

rawPayload

Raw Payload

Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default.

boolean

false

replayId

Replay Id

The replayId value to use when subscribing to the Streaming API.

long

Dependencies

At runtime, the salesforce-source Kamelet relies upon the presence of the following dependencies:

camel:jackson
camel:salesforce
camel:kamelet

Camel JBang usage

Prerequisites

You’ve installed JBang.
You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:salesforce-source"
      parameters:
        .
        .
        .
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/salesforce-source.kamelet.yaml