# Configuration Reference for Zendesk Source Connector for Confluent Platform To use this connector, specify the name of the connector class in the `connector.class` configuration property. ```properties connector.class=io.confluent.connect.zendesk.ZendeskSourceConnector ``` Connector-specific configuration properties are described below. #### NOTE These are properties for the self-managed connector. If you are using Confluent Cloud, see [Zendesk Source Connector for Confluent Cloud](/cloud/current/connectors/cc-zendesk-source.html). ## Zendesk `zendesk.url` : Service URL.
* Type: string * Valid Values: URI with one of these schemes: ‘http’, ‘https’ * Importance: high `zendesk.tables` : The Zendesk tables that are to be exported and written to Kafka. To create a reasonable load balance between workers, the tables can be ordered by their expected size or throughput.
* Type: list * Valid Values: one of [custom_roles, groups, group_memberships, organizations, organization_subscriptions, organization_memberships, satisfaction_ratings, tickets, ticket_audits, ticket_fields, ticket_metrics, users] * Importance: high `zendesk.since` : Rows updated after this time will be processed by the connector. If left blank, the default time will be set to the time this connector is launched minus 1 minute. The value should be formatted as ISO 8601. Example format `yyyy-MM-dd'T'HH:mm:SS`.
* Type: string * Default: “” * Valid Values: either blank, or timestamp in one of these formats: `yyyy-MM-dd`, `yyyy-MM-dd'T'HH:mm:SS`, `yyyy-'W'w-6EX`, `yyyy-MM-dd'T'HH:mm:SSV`. Example have a value of `2020-02-01`, if connector should only export data updated after 1st February, 2020 and ignore all those before. * Importance: medium ## Topics `topic.name.pattern` : The pattern to use for the topic name, where the `${entityName}` literal will be replaced with each entity name (Zendesk table name). Example a value such as `zendesk_topic_${entityName}` with tables `tickets` and `users` would create 2 topics `zendesk_topic_tickets` and `zendesk_topic_users` and ensure that table `tickets` is exported to topic `zendesk_topic_tickets`, etc.
* Type: string * Default: ${entityName} * Importance: high ## Limits `max.batch.size` : The maximum number of records that should be returned and written to Kafka at once.
* Type: int * Default: 100 * Valid Values: [1,…,2147483647] * Importance: high `max.in.flight.requests` : The maximum number of requests that may be in-flight at once.
* Type: int * Default: 10 * Valid Values: [1,…,200] * Importance: high `max.poll.interval.ms` : The time in milliseconds to wait while polling for a full batch of records.
* Type: long * Default: 100 * Valid Values: [1,…,300000] * Importance: medium `request.interval.ms` : The time in milliseconds to wait before checking for updated records.
* Type: long * Default: 15000 * Valid Values: [1,…,2147483647] * Importance: medium ## Retries `max.retries` : The maximum number of times to retry on errors before failing the task.
* Type: int * Default: 10 * Valid Values: [0,…,2147483647] * Importance: medium `retry.backoff.ms` : The time in milliseconds to wait following an error before a retry attempt is made.
* Type: int * Default: 3000 * Valid Values: [0,…,2147483647] * Importance: medium ## Authorization `zendesk.auth.type` : Authentication type of the endpoint. Valid values are `none`, `basic`, `oauth2`, `bearer` (Client Credentials grant type only).
* Type: string * Default: none * Valid Values: one of [bearer, none, basic, oauth2] * Importance: high * Dependents: `bearer.token`, `oauth2.token.url`, `oauth2.client.id`, `oauth2.client.secret`, `oauth2.token.property`, `oauth2.client.mode`, `oauth2.client.scope`, `zendesk.password`, `zendesk.user` `zendesk.user` : The username to be used with an endpoint requiring authentication.
* Type: string * Default: “” * Importance: high `zendesk.password` : The password to be used with an endpoint requiring authentication.
* Type: password * Default: [hidden] * Importance: high `bearer.token` : The bearer authentication token to be used when `auth.type=bearer`. The supplied token will be used as the value of `Authorization` header in HTTP requests.
* Type: password * Default: [hidden] * Importance: high `oauth2.token.url` : The URL to be used for fetching OAUTH2 token. Client Credentials is the only supported grant type.
* Type: string * Default: “” * Valid Values: either blank or null, or URI with one of these schemes: ‘http’, ‘https’ * Importance: high `oauth2.client.id` : The client id used when fetching OAuth2 token
* Type: string * Default: “” * Importance: high `oauth2.client.secret` : The secret used when fetching OAuth2 token
* Type: password * Default: [hidden] * Importance: high `oauth2.token.property` : The name of the property containing the OAuth2 token returned by the http proxy. Default value is `access_token`.
* Type: string * Default: access_token * Importance: high `oauth2.client.mode` : Specifies how to encode `client_id` and `client_secret` in the OAuth2 authorization request. If set to `header`, the credentials are encoded as an `'Authorization: Basic '` HTTP header. If set to ‘url’, then `client_id` and `client_secret` are sent as URL encoded parameters.
* Type: string * Default: header * Valid Values: one of [header, url] * Importance: low `oauth2.client.scope` : The scope parameter sent to the service when fetching OAuth2 token.
* Type: string * Default: any * Importance: low ## Proxy `http.proxy.host` : The host or ip of the http proxy.
* Type: string * Default: “” * Importance: high `http.proxy.port` : The port number of the http proxy.
* Type: int * Default: 0 * Valid Values: [0,…,65535] * Importance: high `http.proxy.user` : The username to be used when authenticating with the http proxy.
* Type: string * Default: “” * Importance: high `http.proxy.password` : The password to be used when authenticating with the http proxy.
* Type: password * Default: [hidden] * Importance: high ## Auto topic creation Configuration properties accept regular expressions (regex) that are defined as [Java regex](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html). `topic.creation.groups` : A list of group aliases that are used to define per-group topic configurations for matching topics. A `default` group always exists and matches all topics.
* Type: List of String types * Default: empty * Possible Values: The values of this property refer to any additional groups. A `default` group is always defined for topic configurations. `topic.creation.$alias.replication.factor` : The replication factor for new topics created by the connector. This value must not be larger than the number of brokers in the Kafka cluster. If this value is larger than the number of Kafka brokers, an error occurs when the connector attempts to create a topic. This is a **required property** for the `default` group. This property is optional for any other group defined in `topic.creation.groups`. Other groups use the Kafka broker default value.
* Type: int * Default: n/a * Possible Values: `>= 1` for a specific valid value or `-1` to use the Kafka broker’s default value. `topic.creation.$alias.partitions` : The number of topic partitions created by this connector. This is a **required property** for the `default` group. This property is optional for any other group defined in `topic.creation.groups`. Other groups use the Kafka broker default value.
* Type: int * Default: n/a * Possible Values: `>= 1` for a specific valid value or `-1` to use the Kafka broker’s default value. `topic.creation.$alias.include` : A list of strings that represent regular expressions that match topic names. This list is used to include topics with matching values, and apply this group’s specific configuration to the matching topics. `$alias` applies to any group defined in `topic.creation.groups`. This property does not apply to the `default` group.
* Type: List of String types * Default: empty * Possible Values: Comma-separated list of exact topic names or regular expressions. `topic.creation.$alias.exclude` : A list of strings representing regular expressions that match topic names. This list is used to exclude topics with matching values from getting the group’s specfic configuration. `$alias` applies to any group defined in `topic.creation.groups`. This property does not apply to the `default` group. Note that exclusion rules override any inclusion rules for topics.
* Type: List of String types * Default: empty * Possible Values: Comma-separated list of exact topic names or regular expressions. `topic.creation.$alias.${kafkaTopicSpecificConfigName}` : Any of the [Changing Broker Configurations Dynamically](/platform/current/kafka/dynamic-config.html#changing-broker-configurations-dynamically) for the version of the Kafka broker where the records will be written. The broker’s topic-level configuration value is used if the configuration is not specified for the rule. `$alias` applies to the `default` group as well as any group defined in `topic.creation.groups`.
* Type: property values * Default: Kafka broker value ## CSFLE and CSPE configurations `csfle.enabled` Accepts a boolean value. CSFLE is enabled for the connector if `csfle.enabled` is set to True. * Type: boolean * Default: False `auto.register.schemas` Specifies if the Serializer should attempt to register the Schema with Schema Registry. * Type: boolean * Default: true * Importance: medium `use.latest.version` Only applies when `auto.register.schemas` is set to false. If `auto.register.schemas` is set to false and `use.latest.version` is set to true, then instead of deriving a schema for the object passed to the client for serialization, Schema Registry uses the latest version of the schema in the subject for serialization. * Type: boolean * Default: true * Importance: medium ## Confluent Platform license `confluent.license` : Confluent will issue a license key to each subscriber. The license key will be a short snippet of text that you can copy and paste. Without the license key, you can use the connector for a 30-day trial period. If you are a subscriber, contact [Confluent Support](https://support.confluent.io) for more information.
* Type: string * Default: “” * Valid Values: Confluent Platform license * Importance: high `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,...`. These servers are used only for the initial connection to discover the full cluster membership, which may change dynamically, so this list need not contain the full set of servers. You may want more than one, 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 You can put license-related properties in the connector configuration, or in license-related properties in the [Connect worker configuration](https://docs.confluent.io/kafka-connectors/self-managed/license.html#centralized-license-in-the-kconnect-long-worker) instead of in each connector configuration. This connector is proprietary and requires a license. The license information is stored in the `_confluent-command` topic. If the broker requires SSL for connections, you must include the security-related `confluent.topic.*` properties as described below. `confluent.license` : Confluent issues enterprise license keys to each subscriber. The license key is text that you can copy and paste as the value for `confluent.license`. A trial license allows using the connector for a 30-day trial period. A developer license allows using the connector indefinitely for single-broker development environments.
If you are a subscriber, contact Confluent Support for more information.
* Type: string * Default: “” * Valid Values: Confluent Platform license * Importance: high `confluent.topic.ssl.truststore.location` : The location of the trust store file.
* Type: string * Default: null * Importance: high `confluent.topic.ssl.truststore.password` : The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.
* Type: password * Default: null * Importance: high `confluent.topic.ssl.keystore.location` : The location of the key store file. This is optional for client and can be used for two-way authentication for client.
* Type: string * Default: null * Importance: high `confluent.topic.ssl.keystore.password` : The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.
* Type: password * Default: null * Importance: high `confluent.topic.ssl.key.password` : The password of the private key in the key store file. This is optional for client.
* Type: password * Default: null * Importance: high `confluent.topic.security.protocol` : Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
* Type: string * Default: “PLAINTEXT” * Importance: medium ### License topic configuration A Confluent enterprise license is stored in the `_confluent-command` topic. This topic is created by default and contains the license that corresponds to the license key supplied through the `confluent.license` property. No public keys are stored in Kafka topics. The following describes how the default `_confluent-command` topic is generated under different scenarios: * A 30-day trial license is automatically generated for the `_confluent-command` topic if you do not add the `confluent.license` property or leave this property empty (for example, `confluent.license=`). * Adding a valid license key (for example, `confluent.license=`) adds a valid license in the `_confluent-command` topic. Here is an example of the minimal properties for development and testing. You can change the name of the `_confluent-command` topic using the `confluent.topic` property (for instance, if your environment has strict naming conventions). The example below shows this change and the configured Kafka bootstrap server. ```none confluent.topic=foo_confluent-command confluent.topic.bootstrap.servers=localhost:9092 ``` The example above shows the minimally required bootstrap server property that you can use for development and testing. For a production environment, you add the normal producer, consumer, and topic configuration properties to the connector properties, prefixed with `confluent.topic.`. ### License topic ACLs The `_confluent-command` topic contains the license that corresponds to the license key supplied through the `confluent.license` property. It is created by default. Connectors that access this topic require the following ACLs configured: * CREATE and DESCRIBE on the resource cluster, if the connector needs to create the topic. * DESCRIBE, READ, and WRITE on the `_confluent-command` topic. #### IMPORTANT You can also use DESCRIBE and READ without WRITE to restrict access to read-only for license topic ACLs. If a topic exists, the LicenseManager will not try to create the topic. You can provide access either individually for each principal that will use the license or use a [wildcard entry](/platform/current/kafka/authorization.html#acl-wildcard-principals) to allow all clients. The following examples show commands that you can use to configure ACLs for the resource cluster and `_confluent-command` topic. 1. Set a CREATE and DESCRIBE ACL on the resource cluster: ```none kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User: \ --operation CREATE --operation DESCRIBE --cluster ``` 2. Set a DESCRIBE, READ, and WRITE ACL on the `_confluent-command` topic: ```none kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User: \ --operation DESCRIBE --operation READ --operation WRITE --topic _confluent-command ``` ### Override Default Configuration Properties You can override the replication factor using `confluent.topic.replication.factor`. For example, when using a Kafka cluster as a destination with less than three brokers (for development and testing) you should set the `confluent.topic.replication.factor` property to `1`. You can override producer-specific properties by using the `producer.override.*` prefix (for source connectors) and consumer-specific properties by using the `consumer.override.*` prefix (for sink connectors). You can use the defaults or customize the other properties as well. For example, the `confluent.topic.client.id` property defaults to the name of the connector with `-licensing` suffix. You can specify the configuration settings for brokers that require SSL or SASL for client connections using this prefix. You cannot override the cleanup policy of a topic because the topic always has a single partition and is compacted. Also, do not specify serializers and deserializers using this prefix; they are ignored if added.