Salesforce SObject Sink Connector for Confluent Cloud

Note

If you are installing the connector locally for Confluent Platform, see Salesforce SObject Sink Connector for Confluent Platform.

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.

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 Kafka record value formats. Schema Registry must be enabled to use these Schema Registry-based formats.

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

Limitations

Be sure to review the following 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 CLI installed and configured for the cluster. See Install the Confluent CLI.
  • Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). See Schema Registry Enabled Environments for additional information.
  • 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 Confluent Cloud for installation instructions.

Step 2: Add a connector.

In the left navigation menu, click Data integration, and then click Connectors. If you already have connectors in your cluster, click + Add connector.

Step 3: Select your connector.

Click the Salesforce SObject Sink connector card.

Salesforce SObject Sink Connector Card

Step 4: Enter the connector details.

Note

  • Ensure you have all your prerequisites completed.
  • An asterisk ( * ) designates a required entry.

At the Add PagerDuty Sink Connector screen, complete the following:

If you’ve already populated your Kafka topics, select the topic(s) you want to connect from the Topics list.

To create a new topic, click +Add new topic.

Step 5: 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 CLI

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

Note

  • Make sure you have all your prerequisites completed.
  • The example commands use Confluent CLI version 2. For more information see, Confluent CLI v2.

Step 1: List the available connectors.

Enter the following command to list available connectors:

confluent connect plugin list

Step 2: Show the required connector configuration properties.

Enter the following command to show the required connector properties:

confluent connect plugin describe <connector-catalog-name>

For example:

confluent connect plugin describe SalesforceSObjectSink

Example output:

Following are the required configs:
connector.class: SalesforceSObjectSink
input.data.format
name
kafka.auth.mode
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.auth.mode": "KAFKA_API_KEY",
  "kafka.api.key": "<my-kafka-api-key>",
  "kafka.api.secret": "<my-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 Kafka record value 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.auth.mode": Identifies the connector authentication mode you want to use. There are two options: SERVICE_ACCOUNT or KAFKA_API_KEY (the default). To use an API key and secret, specify the configuration properties kafka.api.key and kafka.api.secret, as shown in the example configuration (above). To use a service account, specify the Resource ID in the property kafka.service.account.id=<service-account-resource-ID>. To list the available service account resource IDs, use the following command:

    confluent iam service-account list
    

    For example:

    confluent iam service-account list
    
       Id     | Resource ID |       Name        |    Description
    +---------+-------------+-------------------+-------------------
       123456 | sa-l1r23m   | sa-1              | Service account 1
       789101 | sa-l4d56p   | sa-2              | Service account 2
    
  • 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.

Single Message Transforms: See the Single Message Transforms (SMT) documentation for details about adding SMTs using the CLI.

See Configuration Properties for all 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:

confluent connect create --config <file-name>.json

For example:

confluent connect 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:

confluent connect 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

Use the following configuration properties with this connector.

Which topics do you want to get data from?

topics

Identifies the topic name or a comma-separated list of topic names.

  • Type: list
  • Importance: high

Input messages

input.data.format

Sets the input Kafka record value format. Valid entries are AVRO, JSON_SR and PROTOBUF. Note that you need to have Confluent Cloud Schema Registry configured

  • Type: string
  • Importance: high

How should we connect to your data?

name

Sets a name for your connector.

  • Type: string
  • Valid Values: A string at most 64 characters long
  • Importance: high

Kafka Cluster credentials

kafka.auth.mode

Kafka Authentication mode. It can be one of KAFKA_API_KEY or SERVICE_ACCOUNT. It defaults to KAFKA_API_KEY mode.

  • Type: string
  • Default: KAFKA_API_KEY
  • Valid Values: KAFKA_API_KEY, SERVICE_ACCOUNT
  • Importance: high
kafka.api.key
  • Type: password
  • Importance: high
kafka.service.account.id

The Service Account that will be used to generate the API keys to communicate with Kafka Cluster.

  • Type: string
  • Importance: high
kafka.api.secret
  • Type: password
  • Importance: high

How should we connect to Salesforce?

salesforce.instance

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

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
  • Importance: high
salesforce.consumer.key

The consumer key for the OAuth application.

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

The consumer secret for the OAuth application.

  • Type: password
  • Importance: high
salesforce.object

The Salesforce SObject to write to.

  • Type: string
  • Importance: high

Salesforce SObject properties

salesforce.object.override.event.type

A flag to indicate that the Kafka SObject source record EventType(create, update, delete) is overridden to use the operation specified in the SObject override operation field.

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

The Salesforce sink operation to perform on the SObject. One of: insert, update, upsert, delete. Default is insert. This feature works if override.event.type is true.

  • Type: string
  • Default: insert
  • Importance: low
salesforce.ignore.fields

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

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

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

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

Flag to use custom external id field in SObjects.

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

Name of a custom external id field in SObject to structure Rest Api calls for insert, upsert, delete, and update operations.

  • Type: string
  • Importance: low

Connection details

connection.timeout

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

  • Type: long
  • Default: 30000
  • Importance: low
request.max.retries.time.ms

In case of error when making a request to Salesforce, the connector will retry until this time (in ms) elapses. The default value is 30000 (30 seconds). Minimum value is 1 sec

  • Type: long
  • Default: 30000 (30 seconds)
  • Valid Values: [1000,…,250000]
  • Importance: low
behavior.on.api.errors

Error handling behavior config for any API errors.

  • Type: string
  • Default: ignore
  • Importance: low

Number of tasks for this connector

tasks.max
  • Type: int
  • Valid Values: [1,…]
  • Importance: high

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 CLI to manage your resources in Confluent Cloud.

../_images/topology.png