Connect to ServiceDesk Plus Data in JRuby

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

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

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

Using OAuth Authentication

ServiceDeskPlus uses Zoho OAuth 2.0 for secure authentication. To set up OAuth access:

1. Register your application in the Zoho Developer Console at https://api-console.zoho.com
2. Configure your redirect URI to match your application setup
3. Note your Client ID and Client Secret from the application settings

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• OAuthClientId: Set this to your Zoho application Client ID.
• OAuthClientSecret: Set this to your Zoho application Client Secret.
• Scope: Set this to the required ServiceDeskPlus permissions (default includes read access to requests, problems, assets, and projects).
• Domain: Set this to your ServiceDeskPlus domain
• Portal: Set this to your ServiceDeskPlus portal

Example Connection String

Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the ServiceDesk Plus 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 ServiceDesk Plus:

jdbc:api:Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;

Create a JRuby App with Connectivity to ServiceDesk Plus 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 ServiceDesk Plus 2018/lib/cdata.jdbc.api.jar'

url = "jdbc:api:Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT ,  FROM AnnouncementComments")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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