Important

You are viewing documentation for an older version of Confluent Platform. For the latest, click here.

Salesforce Source Connector Configuration Options

The Salesforce Source Connector Connector can be configured using a variety of configuration properties.

Connection

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.password

Salesforce password to connect with.

  • Type: Password
  • Importance: High
salesforce.password.token

The Salesforce security token associated with the username.

  • Type: Password
  • Importance: High
salesforce.username

Salesforce username to connect with.

  • Type: String
  • Importance: High
salesforce.instance

The Salesforce instance to connect to.

  • Type: String
  • Importance: High
connection.timeout

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

  • Type: Long
  • Importance: Low
  • Default Value: 30000
  • Valid Values: [5000,…,600000]
curl.logging

If enabled the logs will output the equivalent curl commands. This is a security risk because your authorization header will end up in the log file. Use at your own risk.

  • Type: Boolean
  • Importance: Low
  • Default Value: false
salesforce.version

The version of the salesforce API to use.

  • Type: String
  • Importance: Low
  • Default Value: latest
  • Valid Values: Matches regex( ^(latest|[d.]+)$ )

Kafka

kafka.topic

The Kafka topic to write the SalesForce data to. This is a template driven by the data returned by Salesforce. Any field in the schema can be used but you should always pick a value that is guaranteed to be there. _EventType and _ObjectType are two metadata fields that are included on every record. For example you could put update and deletes in a different topic by using salesforce.${_ObjectType}.${_EventType}

  • Type: String
  • Importance: High
kafka.topic.lowercase

Flag to determine if the kafka topic should be lowercased.

  • Type: Boolean
  • Importance: High
  • Default Value: true

Salesforce Streaming

salesforce.object

The Salesforce object to create a topic for.

  • Type: String
  • Importance: High
salesforce.push.topic.name

The Salesforce topic to subscribe to. If salesforce.push.topic.create is set to true, a PushTopic with this name will be created.

  • Type: String
  • Importance: High
salesforce.push.topic.create

Flag to determine if the PushTopic should be created if it does not exist.

  • Type: Boolean
  • Importance: Low
  • Default Value: true
salesforce.push.topic.notify.create

Flag to determine if the PushTopic should respond to creates.

  • Type: Boolean
  • Importance: Low
  • Default Value: true
salesforce.push.topic.notify.delete

Flag to determine if the PushTopic should respond to deletes.

  • Type: Boolean
  • Importance: Low
  • Default Value: true
salesforce.push.topic.notify.undelete

Flag to determine if the PushTopic should respond to undeletes.

  • Type: Boolean
  • Importance: Low
  • Default Value: true
salesforce.push.topic.notify.update

Flag to determine if the PushTopic should respond to updates.

  • Type: Boolean
  • Importance: Low
  • Default Value: true