Getting started

Prerequisites

The Kafka Connect framework v2.5 or later should be installed in the environment.

To utilize the connectors, ensure you have the following:

  • SAP® Java Connector 3.1 SDK: Available here

We recommend using:

  • SAP® JCo library version 3.1.11 (including both JAR and native library)

The library must be included in your classpath or placed in the plugin path configured for Kafka Connect.

Note

The SAP® JCo library must be acquired separately from the SAP® Marketplace. For detailed information on licensing and how to obtain a license, please refer to the SAP® FAQ and the SAP® Connectors homepage.

Installation Instructions

Package Structure

The ODP Source Connector package name is: init-kafka-connect-odp-\<connector version>.zip

The ZIP archive contains the following directories:

  • doc/: Provides comprehensive documentation, including licensing information and configuration details.
  • etc/: Contains a sample properties file for the connector, which can be used as a configuration argument during Kafka Connect startup or uploaded via the Confluent Control Center.
  • lib/: This folder includes the Java archive (JAR) that should be extracted into Kafka Connect’s plugin.path.
  • assets/: Contains media assets such as icons and company logos.

Manual Installation

  1. Extract the JAR files from the lib/ directory.
  2. Place these JAR files into the plugin.path directory configured for Kafka Connect.

Confluent CLI Installation

You can also install the connector using the Confluent CLI. For instructions, refer to the Confluent CLI Command Reference. In addition to that, SAP JCo needs to be copied manually to the lib/ directory of the connectors target installation path.


Quickstart Guides

This section includes two types of guides to help you get started:

  1. Confluent Platform: Instructions for operating the connector in a Confluent Platform within a Docker container.
  2. Standalone Mode: Instructions for deploying the ODP Source Connector with Apache Kafka Connect in a standalone environment.

It also includes a guide on setting up your license key.

Note

For using all the functionalities of the connector, we recommend going for the Confluent Platform. Please note that the ODP Source Connector is not supported in Confluent Cloud yet.