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 aDSO sink connector package name is: init-kafka-connect-adso-\<connector version>.zip

The ZIP archive contains the following directories:

  • lib/: This folder includes the Java archive (JAR) that should be extracted into Kafka Connect’s plugin.path.
  • etc/: Contains a sample properties file for the connector.
  • doc/: Provides comprehensive documentation, including licensing information and configuration details.
  • assets/: Contains media assets such as icons and company logos.
  • sap/: Includes optional SAP® transport files that can be installed to enhance performance.

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.

SAP System Requirements

The connector can be used for any Advanced DataStore object with the property “Write Change Log”.

Installation of RFC Write API Wrapper

The aDSO Sink Connector utilizes the RFC APIs RSDSO_WRITE_API_RFC to load data and RSDSO_ACTIVATE_REQ_API_RFC to activate loaded requests.
The connector zip package contains a custom SAP enhancement as an SAP transport file. The transport contains a small wrapper for the aDSO RFC Write API that introduces specific performance enhancements. It is essential to install this transport across all relevant SAP systems during the connector installation process to ensure that the aDSO Sink Connector functions properly.

Quickstart Guides

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

  1. Docker Deployment: Instructions for operating the Confluent Platform within a Docker container.
  2. Local Standalone Mode: Instructions for deploying the aDSO Sink Connector with Apache Kafka 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 aDSO Sink Connector is not supported in Confluent Cloud yet.