<a id="tibco-sink-connector"></a>

# TIBCO Sink Connector for Confluent Platform

The Kafka Connect TIBCO Sink connector is used to move messages from Kafka to
[TIBCO Enterprise Messaging Service (EMS)](https://www.tibco.com/products/tibco-enterprise-message-service).

#### NOTE
- If you are required to use the Java Naming and Directory Interface™ (JNDI) to
  connect to TIBCO EMS, there is a general [JMS Sink connector for Confluent
  Platform](https://docs.confluent.io/kafka-connect-jms-sink/current/overview.html)
  available that uses a JNDI-based mechanism to connect to the JMS broker.
- <!-- WARNING: THIS IS A SHARED FILE AND THE SOURCE IS LOCATED IN DOCS-COMMON. DO NOT ADD TO ANY OTHER REPO. -->

  Effective July 6, 2025, only self-managed connector versions that meet or exceed the minimum version listed on the
  [Supported Connector Versions](https://docs.confluent.io/platform/7.8/connect/supported-connector-version.html#supported-connector-versions-till-cp-7-8)
  page receive support from Confluent. Older, unsupported connector versions have been removed from Confluent Marketplace and
  are no longer available for download.

## Features

The TIBCO Sink connector includes the following features:

- [At least once delivery](#tibco-sink-at-least-once-delivery)
- [Dead Letter Queue](#tibco-sink-dead-letter-queue)
- [Multiple tasks](#tibco-sink-multiple-tasks)
- [JMS message format configuration](#tibco-sink-jms-message-formats)
- [Kafka property forwarding to JMS](#tibco-sink-jms-message-forwarding)
- [Client-side encryption](#tibco-sink-csfle-sm)

<a id="tibco-sink-at-least-once-delivery"></a>

### At least once delivery

This connector guarantees that records are delivered to the Kafka topic at least
once. If the connector restarts, there may be some duplicate records in the Kafka
topic.

<a id="tibco-sink-dead-letter-queue"></a>

### Dead Letter Queue

This connector supports the Dead Letter Queue (DLQ) functionality. For
information about accessing and using the DLQ, see [Confluent Platform
Dead Letter Queue](/platform/current/connect/concepts.html#dead-letter-queue).

<a id="tibco-sink-multiple-tasks"></a>

### Multiple tasks

The TIBCO Sink connector supports running one or more tasks. You can specify
the number of tasks in the `tasks.max` configuration parameter. This can lead
to performance gains when multiple files need to be parsed.

<a id="tibco-sink-jms-message-formats"></a>

### JMS message format

The format of outgoing JMS message values is configured with the
`jms.message.format` property, using one of the following options:

#### string (*default*)

When using the `string` message format, record values are run through
`Values.convertToString(...)` from the Connect Data package and produced as a
JMS `TextMessage`.

Primitive values are converted to their string equivalent and structured objects
are transformed to a sensible string representation that is similar to the JSON
representation, with the exception of simple string values (not in objects or
arrays) which are unquoted.

Note that [Single Message
Transformation](/platform/current/connect/transforms/index.html) can be used with the configured
`jms.message.format` to transform the record value to the desired string
representation before the connector processes each record.

#### avro

Record values are serialized without the Avro schema information and produced as
a JMS `BytesMessage`. JMS consumers must have the schema to deserialize the data.

It it is important to note that the connector attempts to infer the Avro schema
for records that have no schema. If the connector cannot infer the schema, the
task is killed. If you are processing data without a schema, consider using one
of the other `jms.message.format` configurations.

#### json

Record values are converted to a UTF-8 encoded JSON representation and produced
as a JMS `TextMessage`.

#### bytes

Record values are passed along in bytes form without any conversion. Note that
record values must be converted to bytes form before the connector processes
them. Configure the `value.converter` property to
`org.apache.kafka.connect.converters.ByteArrayConverter` to ensure the record
values arrive in byte format.

<a id="tibco-sink-jms-message-forwarding"></a>

### Forward Kafka properties to JMS

The connector can be configured to forward various values from the Kafka record
to the JMS Message.

- Enable `jms.forward.kafka.key` to convert the record’s key to a string and
  forward it as the `JMSCorrelationID`.
- Enable `jms.forward.kafka.metadata` to forward the record’s topic,
  partition, and offset on JMS Message properties.
  - Kafka topic is applied to the message as a string property named `KAFKA_TOPIC`.
  - Partition is applied to the message as an Int property named `KAFKA_PARTITION`.
  - Offset is applied to the message as a Long property named `KAFKA_OFFSET`.
- Enable `jms.forward.kafka.headers` to add each header from the SinkRecord to
  the JMS Message as a string property.

#### NOTE
The connector converts the record key and headers to a sensible string
representation that is similar to the JSON representation, with the
exception of simple string values (not in objects or arrays), which are
unquoted. No other conversion is done to the key and headers before
forwarding them on to the JMS Message. If another format is needed,
out-of-the-box or custom [Single Message
Transformation](/platform/current/connect/transforms/index.html) can be used with the connector
to transform the record keys and/or headers to the desired string
representation before the JMS sink connector processes each record.

<a id="tibco-sink-csfle-sm"></a>

### Client-side encryption

This connector supports Client-Side Field Level Encryption (CSFLE) and Client-Side Payload Encryption (CSPE). For more information, see [Manage Client-Side Encryption](https://docs.confluent.io/platform/current/connect/manage-csfle.html).

<a id="tibco-sink-connector-license"></a>

## License

You can use this connector for a 30-day trial period without a license key.

After 30 days, you must purchase a connector subscription which includes [Confluent enterprise license](/platform/current/installation/license.html#enterprise-subscription-license) keys to subscribers, along with [enterprise-level support](https://www.confluent.io/subscription/) for Confluent Platform and your connectors. If you are a subscriber, you can contact [Confluent Support](https://support.confluent.io/) for more information.

For license properties, see [Confluent Platform license](configuration.md#tibco-sink-connector-license-config), and for
information about the license topic, refer to
[License topic configuration](configuration.md#tibco-sink-license-topic-configuration).

## Configuration properties

For a complete list of configuration properties for this connector, see
[Configuration Reference for TIBCO Sink Connector for Confluent Platform](configuration.md#tibco-sink-connector-config).

For an example of how to get Kafka Connect connected to [Confluent Cloud](/cloud/current/index.html), see
[Connect Self-Managed Kafka Connect to Confluent Cloud](/cloud/current/cp-component/connect-cloud-config.html#distributed-cluster).

<a id="tibco-sink-connector-install"></a>

## Install the TIBCO Sink connector

You can install this connector by using the [confluent connect
plugin
install](https://docs.confluent.io/confluent-cli/current/command-reference/connect/plugin/confluent_connect_plugin_install.html)
command, or by manually downloading the ZIP file.

### Prerequisites

- You must install the connector on every machine where Connect will run.
- Kafka Broker: Confluent Platform 3.3.0 or later, or Kafka 0.11.0 or later.
- Connect: Confluent Platform 4.1.0 or later, or Kafka 1.1.0 or later (requires header support in Connect).
- TIBCO EMS with JMS 1.1 support.
- `tibjms` Client Library. For more details, see [Installing TIBCO JMS client library](#installing-tibco-client-jar).
- Java 8+. Note that Java 8 is deprecated in versions 7.2 and later of Confluent Platform. For
  more details, view [Java compatibility with Confluent Platform](/platform/current/installation/versions-interoperability.html#java)
   by version.
- An install of the [Confluent Hub Client](https://docs.confluent.io/home/connect/confluent-hub/client.html). Note
  that this is installed by default with Confluent Enterprise.

### Install the connector using the Confluent CLI

To install the `latest` connector version, navigate to your Confluent Platform installation
directory and run the following command:

```bash
confluent connect plugin install confluentinc/kafka-connect-tibco-source:latest
```

You can install a specific version by replacing `latest` with a version number
as shown in the following example:

```bash
confluent connect plugin install confluentinc/kafka-connect-tibco-source:1.0.0-preview
```

<a id="tibco-client-jar"></a>

### TIBCO client library

The Kafka Connect TIBCO connector does not come with the TIBCO JMS client
library. If you are running a multi-node Connect cluster, the TIBCO connector
and TIBCO JMS client JAR must be installed on every Connect worker in the
cluster. For detailed instructions, see [Installing TIBCO JMS client library](#installing-tibco-client-jar).

<a id="installing-tibco-client-jar"></a>

#### Installing TIBCO JMS client library

This connector relies on a provided `tibjms` client JAR that is included in
the TIBCO EMS installation. The connector will fail to create a connection to
TIBCO EMS if you have not installed the JAR on each Connect worker node.

The installation steps are:

1. Download and Install TIBCO Enterprise Message Service™ ([Mac](https://www.tibco.com/downloads/10930)
   or [Linux](https://www.tibco.com/downloads/10932)).
   If you have already installed TIBCO EMS, skip to the next step.
2. Unzip the download and copy only the `tibco/ems/{version}/lib/tibjms.jar`
   file into the `share/java/kafka-connect-tibco-sink` directory of your Confluent Platform
   installation on each worker node.

   Note that The `share/java/kafka-connect-tibco-sink` directory is for Confluent Platform.
   If you are using a different installation, find the location of the Confluent
   TIBCO Sink connector JAR files and place the `tibjms` JAR file into the
   same directory.
3. Restart all of the Connect worker nodes.

### Install the connector manually

[Download and extract the ZIP file](https://www.confluent.io/hub/confluentinc/kafka-connect-tibco-sink) for your
connector and then follow the manual connector installation
[instructions](/kafka-connectors/self-managed/install.html).

<a id="tibco-sink-connector-quickstart"></a>

## Quick start

This quick start uses the TIBCO Sink connector to consume records from Kafka and
send them to TIBCO Enterprise Message Service™.

1. Download TIBCO Enterprise Message Service™. For installation steps, see [Installing TIBCO JMS client library](#installing-tibco-client-jar).
   Run the appropriate installer. See the [TIBCO Enterprise Message Service™
   documentation](https://docs.tibco.com/products/tibco-enterprise-message-service)
   for more details. Similar documentation is available for each version of TIBCO
   EMS.
2. Install the connector through the [Confluent Marketplace Client](https://docs.confluent.io/current/connect/managing/confluent-hub/client.html).
   ```bash
   # run from your CP installation directory
   confluent connect plugin install confluentinc/kafka-connect-tibco-sink:latest
   ```
3. [Install the TIBCO JMS Client Library](#installing-tibco-client-jar).
4. Start Confluent Platform.
   ```bash
   confluent local start
   ```
5. [Produce](https://docs.confluent.io/current/cli/command-reference/confluent-produce.html)
   test data to the `sink-messages` topic in Kafka.
   ```bash
   seq 10 | confluent local produce sink-messages
   ```
6. Create a `tibco-sink.json` file with the following contents:
   ```json
   {
     "name": "TibcoSinkConnector",
     "config": {
       "connector.class": "io.confluent.connect.jms.TibcoSinkConnector",
       "tasks.max": "1",
       "topics": "sink-messages",
       "tibco.url": "tcp://localhost:7222",
       "tibco.username": "admin",
       "tibco.password": "",
       "jms.destination.type": "queue",
       "jms.destination.name": "connector-quickstart",
       "key.converter": "org.apache.kafka.connect.storage.StringConverter",
       "value.converter": "org.apache.kafka.connect.storage.StringConverter",
       "confluent.topic.bootstrap.servers": "localhost:9092",
       "confluent.topic.replication.factor": "1"
     }
   }
   ```
7. Load the TIBCO Sink connector.
   ```bash
   confluent local load tibco --config tibco-sink.json
   ```
8. Confirm that the connector is in a `RUNNING` state.
   ```bash
   confluent local status tibco
   ```
9. Confirm the messages were delivered to the `connector-quickstart` queue in
   TIBCO.
   ```bash
   # open TIBCO admin tool (password is empty)
   tibco/ems/8.4/bin/tibemsadmin -server "tcp://localhost:7222" -user admin

   > show queue connector-quickstart
   ```