Ready to get started?

Download a free trial of the Sage 200 Driver to get started:

 Download Now

Learn more:

Sage 200 Icon Sage 200 JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Sage 200.

Stream Sage 200 Data into Apache Kafka Topics



Access and stream Sage 200 data in Apache Kafka using the CData JDBC Driver and the Kafka Connect JDBC connector.

Apache Kafka is an open-source stream processing platform that is primarily used for building real-time data pipelines and event-driven applications. When paired with the CData JDBC Driver for Sage 200, Kafka can work with live Sage 200 data. This article describes how to connect, access and stream Sage 200 data into Apache Kafka Topics and to start Confluent Control Center to help users secure, manage, and monitor the Sage 200 data received using Kafka infrastructure in the Confluent Platform.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Sage 200 data. When you issue complex SQL queries to Sage 200, the driver pushes supported SQL operations, like filters and aggregations, directly to Sage 200 and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Sage 200 data using native data types.

Prerequisites

Before connecting the CData JDBC Driver for streaming Sage 200 data in Apache Kafka Topics, install and configure the following in the client Linux-based system.

  1. Confluent Platform for Apache Kafka
  2. Confluent Hub CLI Installation
  3. Self-Managed Kafka JDBC Source Connector for Confluent Platform

Define a New JDBC Connection to Sage 200 data

  1. Download CData JDBC Driver for Sage 200 on a Linux-based system
  2. Follow the given instructions to create a new directory extract all the driver contents into it:
    1. Create a new directory named Sage 200 mkdir Sage200
    2. Move the downloaded driver file (.zip) into this new directory mv Sage200JDBCDriver.zip Sage200/
    3. Unzip the CData Sage200JDBCDriver contents into this new directory unzip Sage200JDBCDriver.zip
  3. Open the Sage 200 directory and navigate to the lib folder ls cd lib/
  4. Copy the contents of the lib folder of Sage 200 into the lib folder of Kafka Connect JDBC. Check the Kafka Connect JDBC folder contents to confirm that the cdata.jdbc.sage200.jar file is successfully copied into the lib folder cp * ../../confluent-7.5.0/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/ cd ../../confluent-7.5.0/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
  5. Install the CData Sage 200 JDBC driver license using the given command, followed by your Name and Email ID java -jar cdata.jdbc.sage200.jar -l
  6. Enter the product key or "TRIAL" (In the scenarios of license expiry, please contact our CData Support team)
  7. Start the Confluent local services using the command: confluent local services start

    This starts all the Confluent Services like Zookeeper, Kafka, Schema Registry, Kafka REST, Kafka CONNECT, ksqlDB and Control Center. You are now ready to use the CData JDBC driver for Sage 200 to stream messages using Kafka Connect Driver into Kafka Topics on ksqlDB.

    Start the Confluent local services
  8. Create the Kafka topics manually using a POST HTTP API Request: curl --location 'server_address:8083/connectors' --header 'Content-Type: application/json' --data '{ "name": "jdbc_source_cdata_sage200_01", "config": { "connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector", "connection.url": "jdbc:sage200:SubscriptionKey=12345;Schema=StandardUK;; InitiateOAuth=GETANDREFRESH", "topic.prefix": "sage200-01-", "mode": "bulk" } }'

    Let us understand the fields used in the HTTP POST body (shown above):

    • connector.class: Specifies the Java class of the Kafka Connect connector to be used.
    • connection.url: The JDBC connection URL to connect with Sage 200 data.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Sage 200 JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.sage200.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      • Schema: Determines which Sage 200 edition you are connecting to. Specify either StandardUK or ProfessionalUK.
      • Subscription Key: Provides access to the APIs that are used to establish a connection. You will first need to log into the Sage 200 API website and subscribe to the API edition that matches your account. You can do so here: https://developer.columbus.sage.com/docs/services/api/uk. Afterwards, the subscription key may be found in your profile after logging into Sage 200.
      Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    • topic.prefix: A prefix that will be added to the Kafka topics created by the connector. It's set to "sage200-01-".
    • mode: Specifies the mode in which the connector operates. In this case, it's set to "bulk", which suggests that the connector is configured to perform bulk data transfer.

    This request adds all the tables/contents from Sage 200 as Kafka Topics.

    Note: The IP Address (server) to POST the request (shown above) is the Linux Network IP Address.

  9. Run ksqlDB and list the topics. Use the commands: ksql list topics; List the Kafka Topics (BigCommerce is shown)
  10. To view the data inside the topics, type the SQL Statement: PRINT topic FROM BEGINNING;

Connecting with the Confluent Control Center

To access the Confluent Control Center user interface, ensure to run the "confluent local services" as described in the above section and type http://<server address>:9021/clusters/ on your local browser.

Connect with Confluent Control Center

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for Sage 200 and start streaming Sage 200 data into Apache Kafka. Reach out to our Support Team if you have any questions.