Ready to get started?

Learn more about the CData JDBC Driver for SAP ByDesign or download a free trial:

Download Now

Connect to SAP ByDesign Data in JRuby

Create a simple JRuby app with access to live SAP ByDesign data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for SAP ByDesign makes it easy to integrate connectivity to live SAP ByDesign data in JRuby. This article shows how to create a simple JRuby app that connects to SAP ByDesign data, executes a query, and displays the results.

Configure a JDBC Connection to SAP ByDesign Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for SAP ByDesign\lib).

JRuby natively supports JDBC, so you can easily connect to SAP ByDesign and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

Set the following connection properties to connect to SAP ByDesign.

  • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.
  • CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
    If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sapbydesign.jar

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

Below is a typical JDBC connection string for SAP ByDesign:

jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;

Create a JRuby App with Connectivity to SAP ByDesign Data

Create a new Ruby file (for example: SAPByDesignSelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for SAP ByDesign 2018/lib/cdata.jdbc.sapbydesign.jar' url = "jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT ID, ProductCategoryID FROM [Inventory Balance]") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your SAP ByDesign data with JRuby. To do so, simply run your file from the command line:

jruby -S SAPByDesignSelect.rb

Writing SQL-92 queries to SAP ByDesign allows you to quickly and easily incorporate SAP ByDesign data into your own JRuby applications. Download a free trial today!