.. _salesforce-platformevent-source-connector-config: Configuration Properties ------------------------ The Salesforce Platform Events Source 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`` 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.username`` The Salesforce username the connector should use. * Type: string * Importance: high ``salesforce.instance`` The URL of the Salesforce endpoint to use. The default is blank. This directs the connector to use the endpoint specified in the authentication response. * Type: string * Default: https://login.salesforce.com * Valid Values: Valid URL with a scheme of ``https`` or ``http`` * Importance: high ``http.proxy`` The HTTP(S) proxy host and port the connector should use when talking to Salesforce. This defaults to a blank string, which corresponds to not using a proxy. * Type: string * Default: null * Valid Values: Of the form `:` where `` is a valid hostname or IP address, and `` is a valid port number * Importance: medium ``connection.timeout`` The amount of time to wait while connecting to the Salesforce streaming endpoint. * Type: long * Default: 30000 * Valid Values: [5000,...,600000] * Importance: low ``curl.logging`` If enabled the logs will output the equivalent curl commands. This is a security risk because your authorization header is displayed in the log file. Use at your own risk. * Type: boolean * Default: false * Importance: low ``request.max.retries.time.ms`` The maximum time in milliseconds that the connector continue retry requests to Salesforce that fail because of network issues once authentication succeeds. The backoff period for each retry attempt uses a randomization function that grows exponentially. But, if the total time spent retrying the request exceeds this duration (15 minutes by default), retries stop and the request fails. This will likely result in task failure. * Type: long * Default: 900000 * Valid Values: [1,...] * Importance: low ``salesforce.version`` The version of the Salesforce API to use. * Type: string * Default: latest * Valid Values: Matches regex( ^(latest|[\d\.]+)$ ) * Importance: low |ak-tm| ^^^^^^^ ``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 exist. ``_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 lowercase. * Type: boolean * Default: true * Importance: high Salesforce Streaming ^^^^^^^^^^^^^^^^^^^^ ``salesforce.platform.event.name`` The Salesforce platform event name to subscribe to. The Event name should end with '__e' suffix. For example: LoginEvent__e * Type: string * Valid Values: Matches regex( .*__e$ ) * Importance: high ``salesforce.initial.start`` Specify the initial starting point for the connector for replaying events. Use ``all`` to send a replayId of -2 to Salesforce that replays all events from last 24 hours, or use ``latest`` to send a replayId of -1 to Salesforce that plays only new incoming events that arrive after the connector has started. The default is ``latest`` in case there are more enqueued events than might be allowed by API limits. * Type: string * Default: latest * Valid Values: Matches regex( ^(all|latest)$ ) * Importance: high .. _salesforce-connector-license-config: |cp| license ^^^^^^^^^^^^ ``confluent.topic.bootstrap.servers`` A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the form host1:port1,host2:port2,.... Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down). * Type: list * Importance: high ``confluent.topic`` Name of the Kafka topic used for Confluent Platform configuration, including licensing information. * Type: string * Default: _confluent-command * Importance: low ``confluent.topic.replication.factor`` The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1). * Type: int * Default: 3 * Importance: low ---------------------------- Confluent license properties ---------------------------- .. include:: ../../includes/security-info.rst .. include:: ../../includes/platform-license.rst .. include:: ../../includes/security-configs.rst .. _salesforce-platformevent-source_license-topic-configuration: .. include:: ../../includes/platform-license-detail.rst .. include:: ../../includes/overriding-default-config-properties.rst