Salesforce Platform Event Source Connector for Confluent Cloud

The Kafka Connect Salesforce Platform Event Source connector for Confluent Cloud provides a way to subscribe to Salesforce Platform Events and write them to an Apache Kafka® topic.

Features

The Salesforce Platform Event Source connector provides the following features:

  • Uses the Salesforce streaming API: This connector uses the Salesforce Streaming API for Platform Events.
  • Set an initial start: Start consuming new platform events or start by consuming all events from the last 72 hours.
  • Supported data formats: The connector supports Avro, JSON Schema, Protobuf, or JSON (schemaless) output data. Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). See Environment Limitations for additional information.
  • Tasks per connector: Organizations can run multiple connectors with a limit of one task per connector (that is, "tasks.max": "1").

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

For more information, see the Confluent Cloud connector limitations.

Quick Start

Use this quick start to get up and running with the Salesforce Platform Event Source connector. The quick start provides the basics of selecting the connector and configuring it to subscribe to a Salesforce Platform Event.

Prerequisites
  • Authorized access to a Confluent Cloud cluster on Amazon Web Services (AWS), Microsoft Azure (Azure), or Google Cloud Platform (GCP).
  • 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 Environment Limitations for additional information.
  • At least one topic must exist in your Confluent Cloud cluster before creating the connector.
  • The Salesforce account should have at least one Platform Event to subscribe to. You will need to know the security token, key, and secret used for the Salesforce account when setting up the connector.
  • For networking considerations, see Network access. To use static egress IPs, see Static Egress IP Addresses.
  • Kafka cluster credentials. The following lists the different ways you can provide credentials.
    • Enter an existing service account resource ID.
    • Create a Confluent Cloud service account for the connector. Make sure to review the ACL entries required in the service account documentation. Some connectors have specific ACL requirements.
    • Create a Confluent Cloud API key and secret. To create a key and secret, you can use confluent api-key create or you can autogenerate the API key and secret directly in the Cloud Console when setting up the 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.

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 Platform Event Source connector icon.

Salesforce Platform Event Source Connector Icon

Important

At least one topic must exist in your Confluent Cloud cluster before creating the connector.

Step 4: Set up the connection.

Complete the following and click Continue.

Note

  • Make sure you have all your prerequisites completed.
  • An asterisk ( * ) designates a required entry.
  1. Enter a connector name.
  2. Select the way you want to provide Kafka Cluster credentials. You can either select a service account resource ID or you can enter an API key and secret (or generate these in the Cloud Console).
  3. Add your Salesforce connection details. Salesforce instance is not required. If not entered, this property defaults to https://login.salesforce.com. The connector uses the endpoint specified in the authentication response from Salesforce. All other fields are required to connect to Salesforce.
  4. Specify the initial starting point for the connector to use when consuming events. Use all to consume all events from last 72 hours. Use latest to consume only the events that arrive after the connector starts. This property defaults to latest.
  5. Add a Connection timeout in milliseconds. This is the amount of time to wait to connect to the Salesforce endpoint. The value defaults to 30000 (30 seconds).
  6. Select the Output Kafka record value format (data coming from the connector): AVRO, JSON (schemaless), 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). See Environment Limitations for additional information.
  7. Enter the number of tasks in use by the connector. Organizations can run multiple connectors with a limit of one task per connector (that is, "tasks.max": "1").
  8. Transforms and Predicates: See the Single Message Transforms (SMT) documentation for details.

See Configuration Properties for configuration property values and descriptions.

Step 5: Launch the connector.

Verify the connection details by previewing the running configuration. Once you’ve validated that the properties are configured to your satisfaction, click Launch.

Tip

For information about previewing your connector output, see Connector Data Previews.

Step 6: Check the connector status.

The status for the connector should go from Provisioning to Running. It may take a few minutes.

Step 7: Check the Kafka topic.

After the connector is running, verify that messages are populating your Kafka topic.

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

For additional information about this connector, see Salesforce Platform Event Source connector for Confluent Platform. Note that not all Confluent Platform connector features are provided in the Confluent Cloud connector.

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

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.

Important

At least one topic must exist in your Confluent Cloud cluster before creating the connector.

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 SalesforcePlatformEventSource

Example output:

Following are the required configs:
connector.class: SalesforcePlatformEventSource
name
kafka.auth.mode
kafka.api.key
kafka.api.secret
kafka.topic
salesforce.username
salesforce.password
salesforce.password.token
salesforce.consumer.key
salesforce.consumer.secret
salesforce.platform.event.name
output.data.format
tasks.max

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": "SalesforcePlatformEventSource",
  "name": "SalesforcePlatformEventSource_0",
  "kafka.auth.mode": "KAFKA_API_KEY",
  "kafka.api.key": "****************",
  "kafka.api.secret": "**********************************************",
  "kafka.topic": "TestPlatformEvent",
  "salesforce.username": "<my-username>",
  "salesforce.password": "**************",
  "salesforce.password.token": "************************",
  "salesforce.consumer.key": "******************************************",
  "salesforce.consumer.secret": "***************************************",
  "salesforce.platform.event.name": "TestEvent__e",
  "output.data.format": "JSON",
  "tasks.max": "1"
}

Note the following property definitions:

  • "connector.class": Identifies the connector plugin name.
  • "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
    
  • "output.data.format": Sets the output Kafka record value format (data coming from the connector). Valid entries are AVRO, JSON_SR, PROTOBUF, or JSON. You must have Confluent Cloud Schema Registry configured if using a schema-based message format (for example, Avro, JSON_SR (JSON Schema), or Protobuf).

  • "tasks.max": Enter the number of tasks in use by the connector. Organizations can run multiple connectors with a limit of one task per connector (that is, "tasks.max": "1").

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

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:

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

For example:

confluent connect create --config salesforce-platform-event-source.json

Example output:

Created connector SalesforcePlatformEventSource_0 lcc-aj3qr

Step 5: Check the connector status.

Enter the following command to check the connector status:

confluent connect list

Example output:

ID          |            Name                  | Status  |  Type
+-----------+----------------------------------+---------+-------+
lcc-aj3qr   | SalesforcePlatformEventSource_0  | RUNNING | source

Step 6: Check the Kafka topic.

After the connector is running, verify that messages are populating your Kafka topic.

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

Configuration Properties

The unique properties used for this connector are defined below.

salesforce.instance

The URL of the Salesforce endpoint to use. This directs the connector to use the endpoint specified in the authentication response. If left blank, this defaults to https://login.salesforce.com.

  • Type: string
  • Default: https://login.salesforce.com
  • Valid Values: Valid URL with a scheme of https or http
  • Importance: high
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: string
  • Importance: high
salesforce.consumer.secret

The consumer secret for the OAuth application.

  • Type: password
  • Importance: high
salesforce.initial.start

Specify the initial starting point for the connector for consuming events. Use all to consume all events from last 72 hours. Use latest to consume only events that arrive after the connector has started.

  • Type: string
  • Default: latest
  • Valid Values: all or latest
  • Importance: high
connection.timeout

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

  • Type: long
  • Default: 30000 (30 seconds)
  • Valid Values: [5000,…,600000]
  • 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 CLI to manage your resources in Confluent Cloud.

../_images/topology.png