Ready to get started?

Learn more about the CData JDBC Driver for Sage 300 or download a free trial:

Download Now

Connect to Sage 300 Data in JRuby

Create a simple JRuby app with access to live Sage 300 data.

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

Configure a JDBC Connection to Sage 300 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 Sage 300\lib).

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

Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

  • Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the option under Security Groups (per each module required).
  • Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
  • Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.

Authenticate to Sage 300 using Basic authentication.

Connect Using Basic Authentication

You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are used for authentication.

  • Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sage300.jar

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

Below is a typical JDBC connection string for Sage 300:

jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;

Create a JRuby App with Connectivity to Sage 300 Data

Create a new Ruby file (for example: Sage300Select.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 Sage 300 2018/lib/cdata.jdbc.sage300.jar' url = "jdbc:sage300:User=SAMPLE;Password=password;URL=http://127.0.0.1/Sage300WebApi/v1/-/;Company=SAMINC;" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT InvoiceUniquifier, ApprovedLimit FROM OEInvoices") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S Sage300Select.rb

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