Salesforce SObject Sink Connector for Confluent Cloud

The Kafka Connect Salesforce SObject Sink Connector performs CRUD operations (create, update, delete, and insert) on Salesforce SObject using data available from Apache Kafka® topics. This connector can be thought of as the inverse of the Salesforce PushTopic Source Connector because it can operate on data created from the Salesforce PushTopic Source connector.

For example, there are two Salesforce.com organizations or Instances: Instance A and Instance B. A data engineer wants to synchronize Salesforce Lead objects from Instance A to Instance B. The engineer can configure and deploy the PushTopic Source connector to stream a Salesforce Lead from Instance A into a single Kafka topic, while the SObject Sink connector is configured to stream a Lead from the Kafka topic into Instance B. Depending upon the configuration, all changes to Lead SObject may be synchronized across organizations.

Important

If you are still on Confluent Cloud Enterprise, please contact your Confluent Account Executive for more information about using this connector.

Features

The Salesforce SObject Sink connector supports the following features:

  • At least once delivery: This connector guarantees that records from the Kafka topic are delivered at least once.

  • Supports multiple tasks: The connector supports running one or more tasks. More tasks may improve performance (that is, consumer lag is reduced with multiple tasks running).

  • Automatically creates topics: The following three topics are automatically created when the connector starts:

    The suffix for each topic name is the connector’s logical ID. In the example below, there are the three connector topics and one pre-existing Kafka topic named pageviews.

    Salesforce SObject Sink Connector Topics

    Connector Topics

    If the records sent to the topic are not in the correct format, or if important fields are missing in the record, the errors are recorded in the error topic, and the connector continues to run.

  • Supported data formats: The connector supports Avro, JSON Schema (JSON-SR), and Protobuf input message formats. Schema Registry must be enabled to use these Schema Registry-based formats.

See Configuration Properties for all available configuration property descriptions. See Cloud connector limitations for additional information.

Quick Start

Use this quick start to get up and running with the Confluent Cloud Salesforce SObject Sink connector. The quick start provides the basics of selecting the connector and configuring it to stream events

Prerequisites
  • Authorized access to a Confluent Cloud cluster on Amazon Web Services (AWS), Microsoft Azure (Azure), or Google Cloud Platform (GCP).
  • An authorized Salesforce user and credentials for the connector.
  • The Confluent Cloud CLI installed and configured for the cluster. See Install and Configure the Confluent Cloud CLI.
  • Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf).
  • At least one source Kafka topic must exist in your Confluent Cloud cluster before creating the sink connector.

Using the Confluent Cloud Console

Step 1: Launch your Confluent Cloud cluster.

See the Quick Start for Apache Kafka using Confluent Cloud for installation instructions.

Step 2: Add a connector.

Click Connectors. If you already have connectors in your cluster, click Add connector.

Step 3: Select your connector.

Click the Salesforce SObject Sink connector icon.

Salesforce SObject Sink Connector Icon

Step 4: Set up the connection.

Note

  • Make sure you have all your prerequisites completed.
  • An asterisk ( * ) designates a required entry.
  1. Select one or more topics.
  2. Enter a connector Name.
  3. Select an Input message format (data coming from the Kafka topic): AVRO, JSON_SR (JSON Schema), or PROTOBUF. A valid schema must be available in Schema Registry to use a schema-based message format (for example, Avro, JSON_SR (JSON Schema), or Protobuf).
  4. Enter your Kafka Cluster credentials. The credentials are either the cluster API key and secret or the service account API key and secret.
  5. Enter the Salesforce connection details. For more information about Salesforce authentication details and what they mean, see Connected App and OAuth Terminology.
  6. Select one or more of the optional Salesforce SObject properties:
    • SObject Override and Override Operation: If set to true, the connector will override a create, update, or delete event based on the override operation selected.
    • SObject Ignore Fields: A comma-delimited list of fields to ignore when the connector is pushing a record to Salesforce.
    • SObject Ignore Reference Fields: Defaults to true. This prevents reference type fields from being inserted or updated in Salesforce.
    • SObject Use Custom Field and SObject Custom Field Name: If set to true, the connector uses a custom field based on the external SObject field name provided. The sink operation substitutes the value of the external source ID field in Kafka into the value of the specified custom external ID field for sink records. Defaults to false.
  7. Enter the Connection timeout. The amount of time to wait in milliseconds when connecting to the Salesforce endpoint.
  8. Enter the number of tasks to use with the connector. More tasks may improve performance (that is, consumer lag is reduced with multiple tasks running).

See Configuration Properties for configuration property values and descriptions.

Step 5: Launch the connector.

Verify the connection details and click Launch.

Step 6: Check the connector status.

The status for the connector should go from Provisioning to Running.

Step 7: Check for records.

Verify that records are being produced at the endpoint.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect section.

Tip

When you launch a connector, a Dead Letter Queue topic is automatically created. See Dead Letter Queue for details.

Using the Confluent Cloud CLI

Complete the following steps to set up and run the connector using the Confluent Cloud CLI.

Note

Make sure you have all your prerequisites completed.

Step 1: List the available connectors.

Enter the following command to list available connectors:

ccloud connector-catalog list

Step 2: Show the required connector configuration properties.

Enter the following command to show the required connector properties:

ccloud connector-catalog describe <connector-catalog-name>

For example:

ccloud connector-catalog describe SalesforceSObjectSink

Example output:

Following are the required configs:
connector.class: SalesforceSObjectSink
input.data.format
name
kafka.api.key
kafka.api.secret
salesforce.username
salesforce.password
salesforce.password.token
salesforce.consumer.key
salesforce.consumer.secret
salesforce.object
tasks.max
topics

Step 3: Create the connector configuration file.

Create a JSON file that contains the connector configuration properties. The following example shows the required connector properties.

{
  "connector.class": "SalesforceSObjectSink",
  "input.data.format": "AVRO",
  "name": "SalesforceSObjectSinkConnector_0",
  "kafka.api.key": "****************",
  "kafka.api.secret": "************************************************",
  "salesforce.username": "<username>",
  "salesforce.password": "<password>",
  "salesforce.password.token": "<password-token>",
  "salesforce.consumer.key": "<consumer-key>",
  "salesforce.consumer.secret": "<consumer-secret>",
  "salesforce.object": "<salesforce-SObject>",
  "tasks.max": "1",
  "topics": "orders",
}

Note the following property definitions:

  • "connector.class": Identifies the connector plugin name.
  • "input.data.format": Sets the input message format (data coming from the Kafka topic). Valid entries are AVRO, JSON_SR, and PROTOBUF. You must have Confluent Cloud Schema Registry configured if using a schema-based message format (for example, Avro, JSON_SR (JSON Schema), or Protobuf).
  • "name": Sets a name for your new connector.
  • "kafka.api.key" and ""kafka.api.secret": These credentials are either the cluster API key and secret or the service account API key and secret.
  • salesforce.<> Required Salesforce connection details. For more information about Salesforce authentication details and what they mean, see Connected App and OAuth Terminology
  • "tasks.max": Enter the maximum number of tasks for the connector to use. More tasks may improve performance (that is, consumer lag is reduced with multiple tasks running).
  • "topics": Enter the topic name or a comma-separated list of topic names.

See Configuration Properties for configuration property values and descriptions.

Step 4: Load the properties file and create the connector.

Enter the following command to load the configuration and start the connector:

ccloud connector create --config <file-name>.json

For example:

ccloud connector create --config salesforce-SObject-sink-config.json

Example output:

Created connector SalesforceSObjectSinkConnector_0 lcc-do6vzd

Step 5: Check the connector status.

Enter the following command to check the connector status:

ccloud connector list

Example output:

ID           |             Name                 | Status  | Type | Trace
+------------+----------------------------------+---------+------+-------+
lcc-do6vzd   | SalesforceSObjectSinkConnector_0 | RUNNING | sink |       |

Step 6: Check for records.

Verify that records are populating the endpoint.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect section.

Tip

When you launch a connector, a Dead Letter Queue topic is automatically created. See Dead Letter Queue for details.

Configuration Properties

The following connector configuration properties can be used with the Salesforce SObject Sink connector for Confluent Cloud.

Connection

salesforce.instance

The URL of the Salesforce endpoint to use. This directs the connector to use the endpoint specified in the authentication response. The default is blank and uses https://login.salesforce.com.

salesforce.username

The Salesforce username the connector should use.

  • Type: string
  • Importance: high
salesforce.password

The Salesforce password the connector should use.

  • Type: password
  • Importance: high
salesforce.password.token

The Salesforce security token associated with the username.

  • Type: password
  • Default: null
  • Importance: high
salesforce.consumer.key

The consumer key for the OAuth application.

  • Type: string
  • Importance: high
salesforce.consumer.secret

The consumer secret for the OAuth application.

  • Type: password
  • Importance: high
salesforce.object

The Salesforce SObject on which the sink operation is performed.

  • Type: string
  • Importance: high
connection.timeout

The amount of time to wait while connecting to the Salesforce endpoint.

  • Type: long
  • Default: 30000
  • Valid Values: [5000,…,600000]
  • Importance: low

Salesforce SObject

salesforce.object.override.event.type

A flag to indicate that the Kafka SObject source record event type (create, update, delete) will be overridden using the operation specified in the salesforce.sink.object.operation property setting.

  • Type: boolean
  • Default: false
  • Importance: low
  • Dependents: salesforce.sink.object.operation
salesforce.sink.object.operation

The Salesforce sink operation to perform on the SObject (insert, update, upsert, delete). Defaults to insert. This feature works if salesforce.object.override.event.type` is true.

  • Type: string
  • Default: insert
  • Valid Values: insert|update|upsert|delete
  • Importance: low
salesforce.ignore.fields

Comma separate list of fields from the source Kafka record to ignore when sinking a record into Salesforce.

  • Type: string
  • Default: “”
  • Importance: low
salesforce.ignore.reference.fields

Flag to prevent reference type fields from being updated or inserted in the Salesforce SObject.

  • Type: boolean
  • Default: false
  • Importance: low
salesforce.use.custom.id.field

Flag to indicate whether to use the salesforce.custom.id.field.name for all sink connector operations.

  • Type: boolean
  • Default: false
  • Importance: low
  • Dependents: salesforce.custom.id.field.name
salesforce.custom.id.field.name

Name of a custom external ID field in the SObject to structure Rest API calls for insert, upsert, delete, and update operations. The sink operation substitutes the value of the external source ID field in Kafka into the value of the specified custom external ID field for sink records. Defaults to false.

  • Type: string
  • Default: null
  • Importance: low

Next Steps

See also

For an example that shows fully-managed Confluent Cloud connectors in action with Confluent Cloud ksqlDB, see the Cloud ETL Demo. This example also shows how to use Confluent Cloud CLI to manage your resources in Confluent Cloud.

../_images/topology.png