Connect to Teamgate Data in JRuby

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

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

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

Start by setting the Profile connection property to the location of the Teamgate Profile on disk (e.g. C:\profiles\Teamgate.apip). Next, set the ProfileSettings connection property to the connection string for Teamgate (see below).

Teamgate API Profile Settings

To obtain your API Key, log into Teamgate and navigate to Settings > Additional Features > External Apps > New API Key Request. For your Auth Token, go to My Profile > Integrations > API Access > Auth Token.

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.jar

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

Below is a typical JDBC connection string for Teamgate:

jdbc:api:Profile=C:\profiles\Teamgate.apip;ProfileSettings='APIKey=your_api_key;AuthToken=your_auth_token';

Create a JRuby App with Connectivity to Teamgate Data

Create a new Ruby file (for example: APISelect.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 Teamgate 2018/lib/cdata.jdbc.api.jar'

url = "jdbc:api:Profile=C:\profiles\Teamgate.apip;ProfileSettings='APIKey=your_api_key;AuthToken=your_auth_token';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Id, Status FROM Activities")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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