Chapter 63. Salesforce Update Sink
Updates an object in Salesforce. The body received must contain a JSON key-value pair for each property to update and sObjectName and sObjectId must be provided as parameters.
Example of key-value pair: { "Phone": "1234567890", "Name": "Antonia" }
63.1. Configuration Options
The following table summarizes the configuration options available for the salesforce-update-sink 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 | ||
| sObjectId * | Object Id | Id of the object. Only required if using key-value pair. | string | ||
| sObjectName * | Object Name | Type of the object. Only required if using key-value pair. | string |
| |
| userName * | Username | The Salesforce username | string | ||
| loginUrl | Login URL | The Salesforce instance login URL | string |
|
Fields marked with an asterisk (*) are mandatory.
63.2. Dependencies
At runtime, the salesforce-update-sink Kamelet relies upon the presence of the following dependencies:
- camel:salesforce
- camel:kamelet
63.3. Usage
This section describes how you can use the salesforce-update-sink.
63.3.1. Knative Sink
You can use the salesforce-update-sink Kamelet as a Knative sink by binding it to a Knative object.
salesforce-update-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: salesforce-update-sink-binding
spec:
source:
ref:
kind: Channel
apiVersion: messaging.knative.dev/v1
name: mychannel
sink:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: salesforce-update-sink
properties:
clientId: "The Consumer Key"
clientSecret: "The Consumer Secret"
password: "The Password"
sObjectId: "The Object Id"
sObjectName: "Contact"
userName: "The Username"
63.3.1.1. Prerequisite
Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
63.3.1.2. Procedure for using the cluster CLI
-
Save the
salesforce-update-sink-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the sink by using the following command:
oc apply -f salesforce-update-sink-binding.yaml
63.3.1.3. Procedure for using the Kamel CLI
Configure and run the sink by using the following command:
kamel bind channel:mychannel salesforce-update-sink -p "sink.clientId=The Consumer Key" -p "sink.clientSecret=The Consumer Secret" -p "sink.password=The Password" -p "sink.sObjectId=The Object Id" -p "sink.sObjectName=Contact" -p "sink.userName=The Username"
This command creates the KameletBinding in the current namespace on the cluster.
63.3.2. Kafka Sink
You can use the salesforce-update-sink Kamelet as a Kafka sink by binding it to a Kafka topic.
salesforce-update-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: salesforce-update-sink-binding
spec:
source:
ref:
kind: KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1
name: my-topic
sink:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: salesforce-update-sink
properties:
clientId: "The Consumer Key"
clientSecret: "The Consumer Secret"
password: "The Password"
sObjectId: "The Object Id"
sObjectName: "Contact"
userName: "The Username"
63.3.2.1. Prerequisites
Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
63.3.2.2. Procedure for using the cluster CLI
-
Save the
salesforce-update-sink-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the sink by using the following command:
oc apply -f salesforce-update-sink-binding.yaml
63.3.2.3. Procedure for using the Kamel CLI
Configure and run the sink by using the following command:
kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic salesforce-update-sink -p "sink.clientId=The Consumer Key" -p "sink.clientSecret=The Consumer Secret" -p "sink.password=The Password" -p "sink.sObjectId=The Object Id" -p "sink.sObjectName=Contact" -p "sink.userName=The Username"
This command creates the KameletBinding in the current namespace on the cluster.
63.4. Kamelet source file
https://github.com/openshift-integration/kamelet-catalog/salesforce-update-sink.kamelet.yaml
