salesforce source 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

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:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the salesforce-source.

Knative source

You can use the salesforce-source Kamelet as a Knative source by binding it to a Knative object.

salesforce-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: salesforce-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: salesforce-source
    properties:
      clientId: The Consumer Key
      clientSecret: The Consumer Secret
      password: The Password
      query: SELECT Id, Name, Email, Phone FROM Contact
      topicName: ContactTopic
      userName: The Username
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the salesforce-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f salesforce-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind channel:mychannel -p "source.clientId=The Consumer Key" -p "source.clientSecret=The Consumer Secret" -p "source.password=The Password" -p "source.query=SELECT Id, Name, Email, Phone FROM Contact" -p "source.topicName=ContactTopic" -p "source.userName=The Username" salesforce-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

You can use the salesforce-source Kamelet as a Kafka source by binding it to a Kafka topic.

salesforce-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: salesforce-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: salesforce-source
    properties:
      clientId: The Consumer Key
      clientSecret: The Consumer Secret
      password: The Password
      query: SELECT Id, Name, Email, Phone FROM Contact
      topicName: ContactTopic
      userName: The Username
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the salesforce-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f salesforce-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "source.clientId=The Consumer Key" -p "source.clientSecret=The Consumer Secret" -p "source.password=The Password" -p "source.query=SELECT Id, Name, Email, Phone FROM Contact" -p "source.topicName=ContactTopic" -p "source.userName=The Username" salesforce-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

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

Back to top