<a id="cc-solace-sink"></a>

# Solace Sink Connector for Confluent Cloud

The fully managed Solace Sink connector for Confluent Cloud exports data from Apache Kafka® to a [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/software/) cluster.

#### NOTE
* This Quick Start is for the fully managed Confluent Cloud connector. If you are
  installing the connector locally for Confluent Platform, see [Solace Sink Connector for
  Confluent Platform](https://docs.confluent.io/kafka-connectors/solace/current/).
* If you require private networking for fully managed connectors, make sure to set up the proper
  networking beforehand. For more information, see [Manage Networking for Confluent Cloud Connectors](networking/internet-resource.md#clusters-connect-cloud).

## Features

* **At least once delivery**: The connector guarantees that records are delivered at least once.
* **Supports multiple tasks**: The connector supports running one or more tasks.
* **Input data formats:** The connector supports Avro, JSON Schema, Protobuf, JSON (schemaless), String, and Bytes input data formats. [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf).

For more information and examples to use with the Confluent Cloud API for Connect,
see the [Confluent Cloud API for Connect Usage Examples](connect-api-section.md#ccloud-connect-api) section.

## Limitations

Be sure to review the following information.

* For connector limitations, see [Solace Sink Connector](limits.md#cc-solace-sink-limits) limitations.
* If you plan to use one or more Single Message Transformations (SMTs), see [SMT Limitations](single-message-transforms.md#cc-single-message-transforms-limitations).

## Quick Start

Use this quick start to get up and running with the Confluent Cloud Solace Sink
connector. The quick start provides the basics of selecting the connector and
configuring it to stream events to Solace.

<a id="cc-solace-sink-prereqs"></a>

Prerequisites
: - Authorized access to a [Confluent Cloud](https://www.confluent.io/confluent-cloud/) cluster on Amazon Web Services (AWS), Microsoft Azure (Azure), or Google Cloud.
  - The Confluent CLI installed and configured for the cluster. See [Install the Confluent CLI](https://docs.confluent.io/confluent-cli/current/install.html).
  - [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf).
  - Solace account credentials and Solace broker connection details, like the host, VPN (if needed), and JMS destination name.
  - For networking considerations, see [Networking and DNS](overview.md#connect-internet-access-resources). To use a set of public egress IP addresses, see [Public Egress IP Addresses for Confluent Cloud Connectors](static-egress-ip.md#cc-static-egress-ips).
  <br/>
  - Kafka cluster credentials. The following lists the different ways you can provide credentials.
    - Enter an existing [service account](service-account.md#s3-cloud-service-account) resource ID.
    - Create a Confluent Cloud [service account](service-account.md#s3-cloud-service-account) for the connector. Make sure to review the ACL entries required in the [service account documentation](service-account.md#s3-cloud-service-account). 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](https://docs.confluent.io/confluent-cli/current/command-reference/api-key/confluent_api-key_create.html) *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

To create and launch a Kafka cluster in Confluent Cloud, see [Create a kafka cluster in Confluent Cloud](../get-started/index.md#cloud-create-kafka-cluster).

#### Step 2: Add a connector

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

#### Step 3: Select your connector

Click the **Solace Sink** connector card.

![Solace Sink Connector Card](images/ccloud-solace-sink-icon.png)

#### Step 4: Enter the connector details

#### NOTE
* Ensure you have all your [prerequisites](#cc-solace-sink-prereqs) completed.
* An asterisk ( \* ) designates a required entry.

At the **Add Solace Sink Connector** screen, complete the following:

### Topic selection

If you’ve already populated your Kafka topics, select the topics you want
to connect from the **Topics** list.

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

### Kafka access

1. Select the way you want to provide **Kafka Cluster credentials**. You can
   choose one of the following options:
   - **My account**: This setting allows your connector to globally access everything
     that you have access to. With a user account, the connector uses an API key and
     secret to access the Kafka cluster. This option is not recommended for production.
   - **Service account**: This setting limits the access for your connector by using a
     [service account](service-account.md#s3-cloud-service-account). This option is recommended for
     production.
   - **Use an existing API key**: This setting allows you to specify an API key and a
     secret pair. You can use an existing pair or create a new one. This method is not
     recommended for production environments.

   #### NOTE
   Freight clusters support only service accounts for Kafka authentication.
2. Click **Continue**.

### Authentication

1. Configure the authentication properties:

   **Authentication method**
   - **Authentication method**: The authentication scheme for Solace. Currently, only `Password` is
     supported.
   - **Use secret manager**: Fetch sensitive configuration values from a secret manager.

   **Secret manager configuration**
   - **Secret manager**: Select the secret manager to use for retrieving sensitive data.
   - **Configurations from Secret manager**: Select the configurations whose values Confluent Cloud should
     fetch from the secret manager.
   - **Provider Integration**: Select an existing provider integration that has access to your secret manager.

   **Solace connection**
   - **Solace host**: IP or hostname and port (optional) of the message
     broker to connect to. If a port is not specified, the default port
     number is 55555 when compression is not in use, or 55003 when
     compression is in use.
   - **Solace username**: Username to authenticate with Solace.
   - **Solace password**: Password to authenticate with Solace.
   - **Message VPN**: Message VPN to use when connecting to the Solace
     message broker.

   **Solace Proxy Connection**
   - **Proxy Enabled**: Whether to enable a proxy for connecting to the Solace broker. Proxy is only
     supported on Dedicated Kafka clusters. When set to `true`,
     `solace.proxy.host` must also be set.
   - **Proxy Host**: The proxy server hostname or IP address for connecting to the Solace broker.
     Required when `solace.proxy.enabled` is `true`.

     #### NOTE
     Proxy settings affect all Solace connectors in the same dedicated
     cluster.
   - **Proxy Type**: The type of proxy server. Valid values are `http` or `socks5`. Defaults
     to `http`.
   - **Proxy Port**: The proxy server port number. Defaults to `3128`.
   - **Proxy Username**: The username for proxy authentication. If specified,
     `solace.proxy.password` must also be set.
   - **Proxy Password**: The password for proxy authentication. Required if `solace.proxy.username`
     is set.

   **Solace secure connection**
   - **SSL Keystore**: Keystore of SSL-enabled VPN for Solace.
   - **SSL Keystore Password**: Keystore password for SSL-enabled VPN for
     Solace.
   - **SSL Truststore**: Truststore containing server CA certificate for
     SSL-enabled VPN for Solace.
   - **SSL Truststore Password**: Truststore password for SSL-enabled VPN for
     Solace.
   - **Validate SSL Certificate**: Whether to validate the SSL
     certificates.
2. Click **Continue**.

### Configuration

#### NOTE
Configuration properties that are not shown in the
Cloud Console use the default values. See
[Configuration Properties](#cc-solace-sink-config-properties) for all property values and
descriptions.

- **Input Kafka record value format**: Select the input Kafka record value format (data coming from the
  Kafka topic). Valid values are AVRO, JSON_SR (JSON Schema), PROTOBUF, or JSON
  (schemaless), STRING, or BYTES. [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format (for
  example, AVRO, JSON_SR (JSON Schema), or PROTOBUF).
- **Dynamic Durables**: For **Dynamic Durables**, select whether the connector creates queues or
  topic endpoints (which are used to support durable subscription names)
  on the message broker. For a `queue` destination, set this property
  to `true`, if the queue doesn’t exist already. If the queue does
  exist, set the property to `false`. The connector will fail if you
  set this property incorrectly.
- **JMS Destination Name**: Enter **JMS Destination Name**, the name of the [JMS destination](https://docs.solace.com/Solace-JMS-API/Working-with-Destination.htm)
  that messages are written to.

### **Show advanced configurations**

- **Schema context**: Select a schema context to use for this connector, if using
  a schema-based data format. This property defaults to the **Default** context,
  which configures the connector to use the default schema set up for Schema Registry in your
  Confluent Cloud environment. A schema context allows you to use separate schemas (like
  schema sub-registries) tied to topics in different Kafka clusters that share the
  same Schema Registry environment. For example, if you select a non-default context, a
  **Source** connector uses only that schema context to register a schema and a
  **Sink** connector uses only that schema context to read from. For more
  information about setting up a schema context, see [What are schema contexts and when should you use them?](../sr/faqs-cc.md#faq-schema-contexts).
- **Compression Level**: Sets the ZLIB compression level for messages
  sent to Solace. The default value is `-1`, which specifies that the
  connector uses the JNDI connection compression level. `0` specifies
  that the connector uses no compression. Levels `-1` through `9`
  enable data compression; where `1` offers the least amount of
  compression and fastest data throughput, and `9` offers the most
  compression and slowest data throughput.
- **JMS Destination Type**: The type of JMS destination. The default
  value is `queue`.
- **Client Description**: Application description on the message broker
  for the data connection. Defaults to Kafka Connect.
- **Forward Kafka Record Key**: Whether to convert Kafka record key to a
  string and forward it on to the JMS Message property
  `JMSCorrelationID`. Default value is `false`.
- **Forward Kafka Record Metadata**: Whether to forward Kafka record
  metadata on the JMS Message properties. Defaults to `false`.
- **Forward Kafka Record Headers**: Whether to add the Kafka record
  headers to the JMS Message as string properties. Defaults to
  `false`.
- **JMS Message Format**: The format for JMS message values. The
  default value is `string`.
- **Character Encoding**: The character encoding to use while writing
  messages. The default is `UTF-8`.

**Additional Configs**

- **Value Converter Schema ID Deserializer**: Sets the class name of the schema ID deserializer for values. The deserializer reads schema IDs from message headers.
- **Value Converter Reference Subject Name Strategy**: Sets the subject reference name strategy for values. Valid entries are `DefaultReferenceSubjectNameStrategy` or `QualifiedReferenceSubjectNameStrategy`. You can use this strategy only with `PROTOBUF` format; the default strategy is `DefaultReferenceSubjectNameStrategy`.
- **Schema ID For Value Converter**: Sets the schema ID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema ID for deserializing message values. This property is applicable only when `value.converter.value.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`.
- **Errors Tolerance**: Use this property to configure the connector’s error handling behavior.

  #### WARNING
  Use this property with caution for sink connectors, as it can lead to data loss. If you set this property to `all`, the connector does not fail on errant records, but logs them (and sends to DLQ for sink connectors) and continues processing. If you set this property to `none`, the connector task fails on errant records.
- **Key Converter Schema ID Deserializer**: Sets the class name of the schema ID deserializer for keys. The deserializer reads schema IDs from message headers.
- **Value Converter Decimal Format**: Specifies the `JSON` or `JSON_SR` serialization format for Connect `DECIMAL` logical type values with two allowed literals:
  `BASE64` to serialize `DECIMAL` logical types as base64 encoded binary data, and
  `NUMERIC` to serialize `DECIMAL` logical type values in `JSON` or `JSON_SR` as a number representing the decimal value.
- **Schema GUID For Key Converter**: Sets the schema GUID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema GUID for deserializing message keys. This property is applicable only when `key.converter.key.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`.
- **Schema GUID For Value Converter**: Sets the schema GUID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema GUID for deserializing message values. This property is applicable only when `value.converter.value.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`.
- **Value Converter Connect Meta Data**: Enables the Connect converter to add its metadata to the output schema. Applies to Avro converters.
- **Value Converter Value Subject Name Strategy**: Determines how to construct the subject name under which the value schema is registered with Schema Registry.
- **Key Converter Key Subject Name Strategy**: Determines how to construct the subject name for key schema registration.
- **Schema ID For Key Converter**: Sets the schema ID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema ID for deserializing message keys. This property is applicable only when `key.converter.key.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`.

**Auto-restart policy**

- **Enable Connector Auto-restart**: Enables the auto-restart behavior of the connector and its
  task in the event of user-actionable errors. Defaults to `true`, enabling the connector to
  automatically restart in case of user-actionable errors. Set this property to `false` to
  disable auto-restart for failed connectors. If disabled, you must manually restart the connector.

**Consumer configuration**

- **Max poll interval(ms)**: Sets the maximum delay between subsequent consume requests to Kafka. Use this property to
  improve connector performance in cases when the connector cannot send records to the sink system.
  The default is 300,000 milliseconds (5 minutes).
- **Max poll records**: Sets the maximum number of records to consume from Kafka in a single request. Use this property to
  improve connector performance in cases when the connector cannot send records to the sink system.
  The default is 500 records.

**Transforms**

- **Single Message Transformations**: To add a new SMT, see [Add transforms](single-message-transforms.md#cc-single-message-transforms-ui).
  For more information about unsupported SMTs, see
  [Unsupported transformations](single-message-transforms.md#cc-single-message-transforms-unsupported-transforms).

**Processing position**

- **Set offsets**: Click **Set offsets** to define a specific offset for
  this connector to begin procession data from. For more information
  on managing offsets, see [Manage offsets](offsets.md#connect-custom-offsets).

- Click **Continue**.

### Sizing

Based on the number of topic partitions you select, you will be provided
with a recommended number of tasks.

1. To change the number of recommended tasks, enter the number of
   [tasks](/platform/current/connect/concepts.html#tasks) for the connector to use in
   the **Tasks** field.
2. Click **Continue**.

### Review and Launch

1. Verify the connection details.
2. Click **Launch**.

   The status for the connector should go from **Provisioning** to
   **Running**.

#### Step 5: Check the results in Solace

Verify that messages are streaming to the Solace event broker.

For more information and examples to use with the Confluent Cloud API for Connect,
see the [Confluent Cloud API for Connect Usage Examples](connect-api-section.md#ccloud-connect-api) section.

### 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](#cc-solace-sink-prereqs) completed.

#### Step 1: List the available connectors

Enter the following command to list available connectors:

```none
confluent connect plugin list
```

#### Step 2: List the connector configuration properties

Enter the following command to show the connector configuration properties:

```none
confluent connect plugin describe <connector-plugin-name>
```

The command output shows the required and optional configuration properties.

#### Step 3: Create the connector configuration file

Create a JSON file that contains the connector configuration properties. The following example shows required connector properties. See [Configuration Properties](#cc-solace-sink-config-properties) for additional configuration property values and descriptions.

```none
{
  "name": "SolaceConnector_0",
  "config": {
    "topics": "pageviews",
    "connector.class": "SolaceSink",
    "name": "SolaceSinkConnector_0",
    "input.data.format": "STRING",
    "kafka.auth.mode": "KAFKA_API_KEY",
    "kafka.api.key": "<my-kafka-api-key>",
    "kafka.api.secret": "<my-kafka-api-secret>",
    "solace.host": "tcps://mr83451.messaging.solace.cloud:55443",
    "solace.username": "<username>",
    "solace.password": "<password>",
    "solace.dynamic.durables": "true",
    "jms.destination.name": "<destination-name>",
    "tasks.max": "1"
  }
}
```

Note the following property definitions:

* `"name"`: Sets a name for your new connector.
* `"connector.class"`: Identifies the connector plugin name.
* `"topics"`: Identifies the topic name or a comma-separated list of topic names.
* `"input.data.format"`:  Sets the input Kafka record value format (data coming from the Kafka topic). Valid entries are **AVRO**, **JSON_SR**, **PROTOBUF**, **STRING**, **JSON** (schemaless), or **BYTES**. You must have [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) configured if using a schema-based message format (for example, Avro, JSON_SR (JSON Schema), or Protobuf).

* `"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](service-account.md#s3-cloud-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:
  ```bash
  confluent iam service-account list
  ```

  For example:
  ```bash
  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
  ```

* `"solace.<...>"`: Enter the connection details. `solace.host` specifies the IP or hostname and port (optional) of the message broker to connect to. For a non-SSL host entry, if a port is not specified and compression is not in use, the default port number used is `55555`. When compression is used, the default port is `55003`. The default port for SSL connections (with or without compression) is `55443`. An SSL host entry would look similar to the following example (valid schemes: tcp, tcps, smf, or smfs). For additional information, see [Data Connection Properties](https://docs.solace.com/Solace-JMS-API/Data-Connection-Properti.htm#Host).
* `"solace.dynamic.durables"`: Whether queues or topic endpoints (used to support durable subscription names) are created on the message broker. For a `queue` destination, set this property to `true`, if the queue doesn’t exist already. If the queue does exist, set the property to `false`. The connector will fail if you set this property incorrectly.
* `"jms.destination.name"`: Enter the `queue` or `topic` name to send messages to.
* `"tasks.max"`: Maximum [tasks](/platform/current/connect/concepts.html#tasks) for the connector to use. More tasks may improve performance.

**SMTs**: For details about adding SMTs using the Confluent CLI, see the [Single Message Transformations](single-message-transforms.md#cc-single-message-transforms) documentation. For a list of SMTs that are not supported with this connector, see [Unsupported transformations](single-message-transforms.md#cc-single-message-transforms-unsupported-transforms).

See [Configuration Properties](#cc-solace-sink-config-properties) for all property values and
descriptions.

#### Step 4: Load the configuration file and create the connector

Enter the following command to load the configuration and start the connector:

```none
confluent connect cluster create --config-file <file-name>.json
```

For example:

```none
confluent connect cluster create --config-file solace-sink-config.json
```

Example output:

```none
Created connector SolaceSinkConnector_0 lcc-ix4dl
```

#### Step 5: Check the connector status

Enter the following command to check the connector status:

```none
confluent connect cluster list
```

Example output:

```none
ID          |       Name             | Status  | Type
+-----------+------------------------+---------+------+
lcc-ix4dl   | SolaceSinkConnector_0  | RUNNING | sink
```

#### Step 6: Check the results in Solace.

Verify that messages are streaming to the Solace event broker.

For more information and examples to use with the Confluent Cloud API for Connect,
see the [Confluent Cloud API for Connect Usage Examples](connect-api-section.md#ccloud-connect-api) section.

<a id="cc-solace-sink-config-properties"></a>

## Configuration Properties

Use the following configuration properties with the fully managed connector. For
self-managed connector property definitions and other details, see the connector
docs in [Self-managed connectors for Confluent Platform](/platform/current/connect/kafka_connectors.html).

### How should we connect to your data?

`name`
: Sets a name for your connector.
  <br/>
  * Type: string
  * Valid Values: A string at most 64 characters long
  * Importance: high

### Which topics do you want to get data from?

`topics.regex`
: A regular expression that matches the names of the topics to consume from. This is useful when you want to consume from multiple topics that match a certain pattern without having to list them all individually.
  <br/>
  * Type: string
  * Importance: low

`topics`
: Identifies the topic name or a comma-separated list of topic names.
  <br/>
  * Type: list
  * Importance: high

`errors.deadletterqueue.topic.name`
: The name of the topic to be used as the dead letter queue (DLQ) for messages that result in an error when processed by this sink connector, or its transformations or converters. Defaults to ‘dlq-${connector}’ if not set. The DLQ topic will be created automatically if it does not exist. You can provide `${connector}` in the value to use it as a placeholder for the logical cluster ID.
  <br/>
  * Type: string
  * Default: dlq-${connector}
  * Importance: low

### Schema Config

`schema.context.name`
: Add a schema context name. A schema context represents an independent scope in Schema Registry. It is a separate sub-schema tied to topics in different Kafka clusters that share the same Schema Registry instance. If not used, the connector uses the default schema configured for Schema Registry in your Confluent Cloud environment.
  <br/>
  * Type: string
  * Default: default
  * Importance: medium

### Input messages

`input.data.format`
: Sets the input Kafka record value format. Valid entries are AVRO, JSON_SR, PROTOBUF, JSON, STRING or BYTES. Note that you need to have Confluent Cloud Schema Registry configured if using a schema-based message format like AVRO, JSON_SR, and PROTOBUF.
  <br/>
  * Type: string
  * 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, whenever possible.
  <br/>
  * Type: string
  * Valid Values: SERVICE_ACCOUNT, KAFKA_API_KEY
  * Importance: high

`kafka.api.key`
: Kafka API Key. Required when kafka.auth.mode==KAFKA_API_KEY.
  <br/>
  * 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.
  <br/>
  * Type: string
  * Importance: high

`kafka.api.secret`
: Secret associated with Kafka API key. Required when kafka.auth.mode==KAFKA_API_KEY.
  <br/>
  * Type: password
  * Importance: high

### Authentication method

`authentication.method`
: Authentication scheme for Solace. Currently only Password is supported.
  <br/>
  * Type: string
  * Default: Password
  * Importance: high

`secret.manager.enabled`
: Fetch sensitive configuration values from a secret manager.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: high

### Secret manager configuration

`secret.manager`
: Select the secret manager to use for retrieving sensitive data.
  <br/>
  * Type: string
  * Importance: high

`secret.manager.managed.configs`
: Select the configurations to fetch their values from the secret manager.
  <br/>
  * Type: list
  * Importance: high

`secret.manager.provider.integration.id`
: Select an existing provider integration that has access to your secret manager.
  <br/>
  * Type: string
  * Importance: high

### How should we connect to your Solace cluster?

`solace.host`
: IP or hostname and port (optional) of the message broker to connect to. If a port is not specified, the default port number is 55555 when compression is not in use, or 55003 when compression is in use.
  <br/>
  * Type: string
  * Importance: high

`solace.username`
: Username to authenticate with Solace.
  <br/>
  * Type: string
  * Importance: high

`solace.password`
: Password to authenticate with Solace.
  <br/>
  * Type: password
  * Importance: high

`solace.vpn`
: Message VPN to use when connecting to the Solace message broker.
  <br/>
  * Type: string
  * Importance: medium

### Connection details

`solace.compression.level`
: ZLIB compression level for messages written to Solace. Valid values for the compression level are -1 through 9. -1 means use the JNDI connection’s compression level. 0 means use no compression. 1 through 9 enables data compression (where 1 offers the least amount of compression and fastest data throughput, and 9 offers the most compression and slowest data throughput)
  <br/>
  * Type: int
  * Default: -1
  * Valid Values: [-1,…,9]
  * Importance: medium

`solace.dynamic.durables`
: Whether queues or topic endpoints (which are used to support durable subscription names), are to be created on the message broker. In case of queue destination, set this property to true if the queue doesn’t exist already, false otherwise. Setting it incorrectly will fail the connector.
  <br/>
  * Type: boolean
  * Importance: low

`solace.client.description`
: Application description on the message broker for the data connection.
  <br/>
  * Type: string
  * Default: Kafka Connect
  * Importance: low

### Solace Proxy Connection

`solace.proxy.enabled`
: Whether to enable proxy for connecting to the Solace broker. Proxy is only supported on dedicated Kafka clusters. When true, solace.proxy.host must also be set.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: medium

`solace.proxy.host`
: Proxy server hostname or IP address for connecting to Solace broker. Required when solace.proxy.enabled is true. Note: Proxy settings affect all Solace connectors in the same dedicated cluster.
  <br/>
  * Type: string
  * Importance: medium

`solace.proxy.type`
: Type of proxy server. Valid values are ‘http’ or ‘socks5’. Defaults to ‘http’.
  <br/>
  * Type: string
  * Default: http
  * Importance: medium

`solace.proxy.port`
: Proxy server port number. Defaults to 3128.
  <br/>
  * Type: int
  * Default: 3128
  * Valid Values: [0,…,65535]
  * Importance: medium

`solace.proxy.username`
: Username for proxy authentication. If specified, solace.proxy.password must also be set.
  <br/>
  * Type: string
  * Importance: medium

`solace.proxy.password`
: Password for proxy authentication. Required if solace.proxy.username is set.
  <br/>
  * Type: password
  * Importance: medium

### Solace secure connection

`solace.ssl.keystore.file`
: Keystore of SSL-enabled VPN for Solace.
  <br/>
  * Type: password
  * Default: [hidden]
  * Importance: medium

`solace.ssl.keystore.password`
: Keystore password for SSL-enabled VPN for Solace.
  <br/>
  * Type: password
  * Importance: medium

`solace.ssl.truststore.file`
: Truststore containing server CA certificate for SSL-enabled VPN for Solace.
  <br/>
  * Type: password
  * Default: [hidden]
  * Importance: medium

`solace.ssl.truststore.password`
: Truststore password for SSL-enabled VPN for Solace.
  <br/>
  * Type: password
  * Importance: medium

`solace.ssl.validate.certificate`
: Whether to validate the SSL certificates.
  <br/>
  * Type: boolean
  * Default: true
  * Importance: medium

### JMS details

`jms.destination.name`
: The name of the JMS destination that messages are written to.
  <br/>
  * Type: string
  * Importance: high

`jms.destination.type`
: The type of JMS destination.
  <br/>
  * Type: string
  * Default: queue
  * Importance: high

`jms.forward.kafka.key`
: Convert the Kafka record key to a string and forward it on the JMS Message property JMSCorrelationID.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: low

`jms.forward.kafka.metadata`
: Forward the Kafka record metadata on the JMS Message properties. This includes the record topic, partition, and offset.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: low

`jms.forward.kafka.headers`
: Add the Kafka record headers to the JMS Message as string properties.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: low

### JMS formatter

`jms.message.format`
: The format of JMS message values.
  <br/>
  * Type: string
  * Default: string
  * Importance: high

`character.encoding`
: The character encoding to use while writing the message.
  <br/>
  * Type: string
  * Default: UTF-8
  * Importance: low

### Consumer configuration

`max.poll.interval.ms`
: The maximum delay between subsequent consume requests to Kafka. This configuration property may be used to improve the performance of the connector, if the connector cannot send records to the sink system. Defaults to 300000 milliseconds (5 minutes).
  <br/>
  * Type: long
  * Default: 300000 (5 minutes)
  * Valid Values: [60000,…,1800000] for non-dedicated clusters and [60000,…] for dedicated clusters
  * Importance: low

`max.poll.records`
: The maximum number of records to consume from Kafka in a single request. This configuration property may be used to improve the performance of the connector, if the connector cannot send records to the sink system. Defaults to 500 records.
  <br/>
  * Type: long
  * Default: 500
  * Valid Values: [1,…,500] for non-dedicated clusters and [1,…] for dedicated clusters
  * Importance: low

### Number of tasks for this connector

`tasks.max`
: Maximum number of tasks for the connector.
  <br/>
  * Type: int
  * Valid Values: [1,…]
  * Importance: high

### Additional Configs

`consumer.override.auto.offset.reset`
: Defines the behavior of the consumer when there is no committed position (which occurs when the group is first initialized) or when an offset is out of range. You can choose either to reset the position to the “earliest” offset (the default) or the “latest” offset. You can also select “none” if you would rather set the initial offset yourself and you are willing to handle out of range errors manually. More details: [https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#auto-offset-reset](https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#auto-offset-reset)
  <br/>
  * Type: string
  * Importance: low

`consumer.override.isolation.level`
: Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode.  More details: [https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#isolation-level](https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#isolation-level)
  <br/>
  * Type: string
  * Importance: low

`header.converter`
: The converter class for the headers. This is used to serialize and deserialize the headers of the messages.
  <br/>
  * Type: string
  * Importance: low

`key.converter.use.schema.guid`
: The schema GUID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema GUID to be used for deserializing message keys. Only applicable when key.converter.key.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
  <br/>
  * Type: string
  * Importance: low

`key.converter.use.schema.id`
: The schema ID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema ID to be used for deserializing message keys. Only applicable when key.converter.key.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
  <br/>
  * Type: int
  * Importance: low

`value.converter.allow.optional.map.keys`
: Allow optional string map key when converting from Connect Schema to Avro Schema. Applicable for Avro Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.auto.register.schemas`
: Specify if the Serializer should attempt to register the Schema.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.connect.meta.data`
: Allow the Connect converter to add its metadata to the output schema. Applicable for Avro Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.enhanced.avro.schema.support`
: Enable enhanced schema support to preserve package information and Enums. Applicable for Avro Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.enhanced.protobuf.schema.support`
: Enable enhanced schema support to preserve package information. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.flatten.unions`
: Whether to flatten unions (oneofs). Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.generate.index.for.unions`
: Whether to generate an index suffix for unions. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.generate.struct.for.nulls`
: Whether to generate a struct variable for null values. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.int.for.enums`
: Whether to represent enums as integers. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.latest.compatibility.strict`
: Verify latest subject version is backward compatible when use.latest.version is true.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.object.additional.properties`
: Whether to allow additional properties for object schemas. Applicable for JSON_SR Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.optional.for.nullables`
: Whether nullable fields should be specified with an optional label. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.optional.for.proto2`
: Whether proto2 optionals are supported. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.use.latest.version`
: Use latest version of schema in subject for serialization when auto.register.schemas is false.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.use.optional.for.nonrequired`
: Whether to set non-required properties to be optional. Applicable for JSON_SR Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.use.schema.guid`
: The schema GUID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema GUID to be used for deserializing message values. Only applicable when value.converter.value.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
  <br/>
  * Type: string
  * Importance: low

`value.converter.use.schema.id`
: The schema ID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema ID to be used for deserializing message values. Only applicable when value.converter.value.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
  <br/>
  * Type: int
  * Importance: low

`value.converter.wrapper.for.nullables`
: Whether nullable fields should use primitive wrapper messages. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`value.converter.wrapper.for.raw.primitives`
: Whether a wrapper message should be interpreted as a raw primitive at root level. Applicable for Protobuf Converters.
  <br/>
  * Type: boolean
  * Importance: low

`errors.tolerance`
: Use this property if you would like to configure the connector’s error handling behavior. WARNING: This property should be used with CAUTION for SOURCE CONNECTORS as it may lead to dataloss. If you set this property to ‘all’, the connector will not fail on errant records, but will instead log them (and send to DLQ for Sink Connectors) and continue processing. If you set this property to ‘none’, the connector task will fail on errant records.
  <br/>
  * Type: string
  * Default: all
  * Importance: low

`key.converter.key.schema.id.deserializer`
: The class name of the schema ID deserializer for keys. This is used to deserialize schema IDs from the message headers.
  <br/>
  * Type: string
  * Default: io.confluent.kafka.serializers.schema.id.DualSchemaIdDeserializer
  * Importance: low

`key.converter.key.subject.name.strategy`
: How to construct the subject name for key schema registration.
  <br/>
  * Type: string
  * Default: TopicNameStrategy
  * Importance: low

`value.converter.decimal.format`
: Specify the JSON/JSON_SR serialization format for Connect DECIMAL logical type values with two allowed literals:
  <br/>
  BASE64 to serialize DECIMAL logical types as base64 encoded binary data and
  <br/>
  NUMERIC to serialize Connect DECIMAL logical type values in JSON/JSON_SR as a number representing the decimal value.
  <br/>
  * Type: string
  * Default: BASE64
  * Importance: low

`value.converter.flatten.singleton.unions`
: Whether to flatten singleton unions. Applicable for Avro and JSON_SR Converters.
  <br/>
  * Type: boolean
  * Default: false
  * Importance: low

`value.converter.reference.subject.name.strategy`
: Set the subject reference name strategy for value. Valid entries are DefaultReferenceSubjectNameStrategy or QualifiedReferenceSubjectNameStrategy. Note that the subject reference name strategy can be selected only for PROTOBUF format with the default strategy being DefaultReferenceSubjectNameStrategy.
  <br/>
  * Type: string
  * Default: DefaultReferenceSubjectNameStrategy
  * Importance: low

`value.converter.value.schema.id.deserializer`
: The class name of the schema ID deserializer for values. This is used to deserialize schema IDs from the message headers.
  <br/>
  * Type: string
  * Default: io.confluent.kafka.serializers.schema.id.DualSchemaIdDeserializer
  * Importance: low

`value.converter.value.subject.name.strategy`
: Determines how to construct the subject name under which the value schema is registered with Schema Registry.
  <br/>
  * Type: string
  * Default: TopicNameStrategy
  * Importance: low

### Auto-restart policy

`auto.restart.on.user.error`
: Enable connector to automatically restart on user-actionable errors.
  <br/>
  * Type: boolean
  * Default: true
  * Importance: medium

## Frequently asked questions

Find answers to frequently asked questions about the Solace Sink connector on Confluent Cloud.

### Why is my connector failing with connection errors?

If your connector fails to connect to Solace, verify the following:

* **Network connectivity**: Ensure your Solace broker is accessible from Confluent Cloud. For private endpoints, you may need to configure [Public Egress IP Addresses for Confluent Cloud Connectors](static-egress-ip.md#cc-static-egress-ips).
* **Authentication credentials**: Verify that `solace.username` and `solace.password` are correct and that the user has the necessary permissions on the Solace broker.
* **Host and port configuration**: Check that `solace.host` uses the correct hostname, port, and protocol scheme like `tcps://` or `smfs://`.
* **VPN configuration**: If your Solace broker uses a Message VPN, ensure it’s properly configured on the broker and accessible with your credentials.
* **Firewall rules**: Confirm that firewall rules allow Confluent Cloud to connect to your Solace broker on the specified port.

### How many tasks should I configure for my connector?

The optimal number of tasks depends on your throughput requirements and the number of topic partitions you’re consuming from.
Consider the following guidelines:

* Start with a number of tasks equal to the number of topic partitions you’re consuming from.
* For higher throughput, you can increase the number of tasks, but this may not improve performance beyond the number of partitions.
* Monitor your connector’s performance and adjust the `tasks.max` setting based on throughput requirements and Solace broker capacity.

Each task creates a separate connection to the Solace broker. Ensure your Solace broker can handle the number of concurrent connections.

### What should I do if messages are not appearing in my Solace destination?

If messages are missing from your Solace queue or topic:

* **Check the Dead Letter Queue (DLQ)**: The connector may have sent failed messages to the DLQ topic. See [View Connector Dead Letter Queue Errors in Confluent Cloud](dead-letter-queue.md#ccloud-dlq-topics) for details.
* **Verify connector status**: Confirm the connector is in `RUNNING` state. Use the Confluent Cloud Console or Confluent CLI to check the status.
* **Review connector logs**: Check the connector logs in the Confluent Cloud Console for error messages or warnings.
* **Confirm destination configuration**: Verify that `jms.destination.name` matches the queue or topic name on your Solace broker.
* **Check message format**: Ensure the `input.data.format` setting matches the format of messages in your Kafka topic.
* **Verify permissions**: Confirm that your Solace user has write permissions to the destination queue or topic.

### What are common configuration errors for this connector?

The following are common configuration errors and how to resolve them:

* **Incorrect solace.dynamic.durables setting**: This is one of the most common errors.
  Set this to true if you want the connector to create the queue or topic endpoint if it does not already exist. While setting this to `true` is safe even if the destination already exists, setting it to `false` will cause the connector to fail if the destination is missing from the Solace broker.
* **Protocol scheme mismatch**: Ensure `solace.host` uses the correct protocol scheme. Use `tcps://` or `smfs://` for SSL/TLS connections. The default ports are:
  \* 55555 for non-SSL connections without compression.
  \* 55003  for non-SSL with compression.
  \* 55443 for SSL connections.
* **Input data format mismatch**: The `input.data.format` must match the format of data in your Kafka topic. If you’re using Avro, JSON Schema, or Protobuf, you must have [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) enabled and properly configured.
* **Authentication configuration errors**: Ensure `kafka.auth.mode` is set correctly, and that both `kafka.api.key` and `kafka.api.secret` are provided with valid credentials.
* **Destination name issues**: Verify that `jms.destination.name` exactly matches the queue or topic name on your Solace broker. Destination names are case-sensitive.
* **VPN name not specified**: If your Solace broker requires a Message VPN, ensure you’ve configured it in the `solace.vpn` configuration property.

### How can I improve connector throughput?

To optimize the performance of the connector, consider the following strategies:

* **Increase the number of tasks**: The `tasks.max` setting controls parallelism. Start with a number equal to your topic partition count, then increase if needed.
* **Increase topic partitions**: If your Kafka topic has few partitions, consider increasing them. The connector can leverage more parallelism when consuming from multiple partitions.
* **Optimize batch settings**: Review and adjust batching configurations to balance between latency and throughput. Larger batches can improve throughput, but may also increase latency.
* **Monitor Solace broker capacity**: Ensure your Solace broker has sufficient resources to handle the incoming message rate. Broker-side bottlenecks can limit connector throughput.
* **Use appropriate message formats**: Binary formats like Avro or Protobuf are more efficient than JSON for high-throughput scenarios. Choose the format that balances your performance needs with usability requirements.
* **Review network configuration**: For high-volume workloads, ensure network bandwidth and latency between Confluent Cloud and your Solace broker are optimal. Consider using private networking or [Public Egress IP Addresses for Confluent Cloud Connectors](static-egress-ip.md#cc-static-egress-ips) for more predictable performance.
* **Enable compression**: If network bandwidth is a bottleneck, consider enabling compression on the Solace connection. Note that this changes the default port to 55003 for non-SSL connections.

## Next Steps

For an example that shows fully managed Confluent Cloud connectors in action with
Confluent Cloud for Apache Flink, see the [Cloud ETL Demo](/platform/current/tutorials/examples/cloud-etl/docs/index.html).
This example also shows how to use Confluent CLI to manage your resources in
Confluent Cloud.

[![image](images/topology.png)](https://docs.confluent.io/platform/current/tutorials/examples/cloud-etl/docs/index.html)