Stream MYOB AccountRight Data into Apache Kafka Topics

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 MYOB AccountRight, Kafka can work with live MYOB AccountRight data. This article describes how to connect, access and stream MYOB AccountRight data into Apache Kafka Topics and to start Confluent Control Center to help users secure, manage, and monitor the MYOB AccountRight 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 MYOB AccountRight data. When you issue complex SQL queries to MYOB AccountRight, the driver pushes supported SQL operations, like filters and aggregations, directly to MYOB AccountRight 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 MYOB AccountRight data using native data types.

Prerequisites

Before connecting the CData JDBC Driver for streaming MYOB AccountRight 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 MYOB AccountRight data

1. Download CData JDBC Driver for MYOB AccountRight 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 MYOB AccountRight

      		mkdir MYOB
      		

   2. Move the downloaded driver file (.zip) into this new directory

      		mv MYOBJDBCDriver.zip MYOB/
      		

   3. Unzip the CData MYOBJDBCDriver contents into this new directory

      		unzip MYOBJDBCDriver.zip
      		

3. Open the MYOB AccountRight directory and navigate to the lib folder

   ls
   cd lib/
   

4. Copy the contents of the lib folder of the CData JDBC Driver for MYOB AccountRight into the lib folder of Kafka Connect JDBC. Check the Kafka Connect JDBC folder contents to confirm that the cdata.jdbc.myob.jar file is successfully copied into the lib folder

   cp -r /path/to/CData JDBC Driver for MYOB AccountRight/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
   cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
   

5. Install the CData MYOB AccountRight JDBC driver license using the given command, followed by your Name and Email ID

   	java -jar cdata.jdbc.myob.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 MYOB AccountRight 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_myob_01", 
   		"config": { 
   			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector", 
   			"connection.url": "jdbc:myob:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; CompanyFileId=yourCompanyFileId; CallbackURL=http://localhost:33333; User=companyFileUser; Password=companyFilePassword;InitiateOAuth=GETANDREFRESH;",
   		"topic.prefix": "myob-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 MYOB AccountRight data.

     Built-in Connection String Designer

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

     		java -jar cdata.jdbc.myob.jar
     		

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

     These properties are required when connecting to a company file (both for Cloud and On-Premise instances).

     • CompanyFileId: You can find this by starting MYOB, opening your data file, and selecting Help -> About MYOB
     • User: The username associated with your company file.
     • Password: The password associated with your company file.

     Connecting to a Cloud Instance

     To connect to a cloud instance of MYOB, you can use the embedded OAuth credentials or create an OAuth app with MYOB. This process is detailed in the Help documentation.

     Connecting to an On-Premise instance:

     When connecting to an on-premise instance, set the following connection property in addition to those above:

     • InitiateOauth: Set this to OFF.
     • Url: The Url of your MYOB instance.
     👁 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 "myob-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 MYOB AccountRight 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.

Get Started Today

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