Ruby でServiceDesk Plus のデータ連携アプリを構築

古川えりか
古川えりか
コンテンツスペシャリスト
Ruby でODBC 経由でServiceDesk Plus に接続して、モダンなクラウド連携アプリを開発。



CData ODBC Driver for API を使うと、簡単にRuby アプリケーションにリアルタイムServiceDesk Plus のデータを連携・統合できます。 この記事では、ServiceDesk Plus のデータにリアルタイムに連携するRuby アプリケーションを構築して、クエリを実行し、結果を表示してみます。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

  1. ServiceDesk Plus をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
  2. 多様なアプリケーション、ツールにServiceDesk Plus のデータを連携
  3. ノーコードでの手軽な接続設定
  4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてServiceDesk Plus の接続を設定、2.Ruby 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとServiceDesk Plus への接続設定

まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

通常はCData ODBC ドライバのインストール後にODBC DSN 接続ウィザードが立ち上がり、設定を行うことができます。 もしODBC DSN 接続が未済の場合には、Microsoft ODBC データソースアドミニストレータでODBC DSN を作成および設定することができます。

OAuth 認証の設定

ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます：

  1. https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
  2. アプリケーション構成に合わせてリダイレクト URI を設定します
  3. アプリケーション設定から Client ID と Client Secret を控えておきます

以下の接続プロパティを設定して接続を確立してください：

  • AuthScheme：OAuth に設定します。
  • OAuthClientId：Zoho アプリケーションの Client ID に設定します。
  • OAuthClientSecret：Zoho アプリケーションの Client Secret に設定します。
  • Scope：必要な ServiceDeskPlus の権限に設定します（デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます）。
  • Domain：ServiceDeskPlus のドメインに設定します。
  • Portal：ServiceDeskPlus のポータルに設定します。

接続文字列の例

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;

Ruby および必要なGem のインストール

Ruby をまだインストールしていない場合は、Ruby インストールページを参考にインストールしてください。 Ruby をインストールしたら、次にruby-dbi、dbd-odbc、ruby-odbc gems をインストールします。 

gem install dbi
gem install dbd-odbc
gem install ruby-odbc

ServiceDesk Plus のデータに連携するRuby アプリケーションの作成

Ruby ファイル (例: APISelect.rb) を作成し、テキストエディタで開きます。ファイルに次のコードをコピーします: 

#connect to the DSN
require 'DBI'
cnxn = DBI.connect('DBI:ODBC:CData API Source','','')

#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT ,  FROM AnnouncementComments WHERE AnnouncementId = '12345'")

#display the names of the columns
resultSet.column_names.each do |name|
  print name, "\t"
end
puts

#display the results
while row = resultSet.fetch do
  (0..resultSet.column_names.size - 1).each do |n|
    print row[n], "\t"
  end
  puts
end
resultSet.finish

#close the connection
cnxn.disconnect if cnxn

これで、Ruby からServiceDesk Plus のデータへ接続できるようになります。簡単にコマンドラインからファイルを叩いて接続を確認してみましょう。 

ruby APISelect.rb

ServiceDesk Plus からRuby へのデータ連携には、ぜひCData ODBC ドライバをご利用ください

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。

はじめる準備はできましたか？

API Driver で ServiceDesk Plus のライブデータに接続

ServiceDesk Plus に接続

この記事の内容

関連記事