salesforce source Salesforce Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

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

The Salesforce application consumer key

string

clientSecret *

Consumer Secret

The Salesforce application consumer secret

string

password *

Password

The Salesforce user password

string

query *

Query

The query to execute on Salesforce

string

"SELECT Id, Name, Email, Phone FROM Contact"

topicName *

Topic Name

The name of the topic/channel to use

string

"ContactTopic"

userName *

Username

The Salesforce username

string

loginUrl

Login URL

The Salesforce instance login URL

string

"https://login.salesforce.com"
Fields marked with (*) are mandatory.

Usage

This section summarizes how the salesforce-source can be used in various contexts.

Knative Source

The salesforce-source Kamelet can be used as Knative source by binding it to a Knative object.

salesforce-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: salesforce-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      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

Make sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the salesforce-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f salesforce-source-binding.yaml

Dependencies

The Kamelet needs the following dependencies:

  • camel:jackson

  • camel:salesforce

  • mvn:org.apache.camel.k:camel-k-kamelet-reify

  • camel:kamelet

Binding to Knative using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind salesforce-source -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" channel:mychannel

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kafka Source

The salesforce-source Kamelet can be used as Kafka source by binding it to a Kafka topic.

salesforce-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: salesforce-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      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

Ensure that you’ve installed Strimzi and created a topic named my-topic in the current namespace. Make also sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the salesforce-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f salesforce-source-binding.yaml

Binding to Kafka using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind salesforce-source -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" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kamelet source file

Have a look at the following link:

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

Back to top