エンタープライズサーチのNeuron にServiceDesk Plus のデータを取り込んで検索利用

ブレインズテクノロジー社のNeuron は、先端OSS 技術（Apache Solr）を活用したエンタープライズサーチ（企業内検索エンジン）サービスです。Apache Solr は、エンタープライズサーチ機能をAPI として提供してくれますが、Neuron はApache Solr に企業ユーザーがデータを探索するためのシンプルかつ使いやすいユーザーインターフェースと管理画面・運用機能を提供してくれます。これによりエンドユーザーが簡単にエンタープライズサーチを利用することができます。管理画面では、ファイルやデータのクローリング設定がUI で行えるようになっています。この記事では、Neuron に備わっているJDBC インターフェース経由で、CData JDBC Driver for API を利用することでNeuron にServiceDesk Plus のデータを取り込んで検索で利用できるようにします。

Neuron にCData JDBC Driver for API データをロード

CData JDBC Driver for API のインストールと.jar ファイルの配置

• CData JDBC Driver for API をNeuron と同じマシンにインストールします。
• 以下のパスにJDBC Driver がインストールされます。
  C:\Program Files\CData\CData JDBC Driver for API 20xxJ\lib\cdata.jdbc.api.jar
  
• このcdata.jdbc.api.jar とcdata.jdbc.api.lic ファイルをコピーして、Neuron のC:\APP cf\lib フォルダに配置します。

Neuron CF でのServiceDesk Plus のデータを扱うリポジトリの作成

• Neuron CF でクローラーの設定をGUI で行います。JDBC を読み取るためのリポジトリを作成します。Neuron の管理画面にログインし、［リポジトリ］→［リポジトリコレクション一覧］→［新規］をクリックします。
• 任意のリポジトリ名を入力します。タイプは［JDBC］を選択します。
• 次に、ドライバーのクラス名とJDBC 接続文字列でServiceDesk Plus への接続を行います。
  

  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;
  

  
  ドライバクラス名：cdata.jdbc.api.APIDriver
  接続文字列：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;InitiateOAuth=REFRESH
• ［更新］をクリックして、ServiceDesk Plus に接続するリポジトリコレクションができました。

Neuron でServiceDesk Plus のデータをクローリングするジョブを作成

続いて、ServiceDesk Plus のどのデータをどのようにクローリングするのかをジョブで定義していきます。

• 管理画面で［ジョブ］→［ジョブ一覧］→［新規］とクリックします。
• 任意のジョブ名を入力します。出力先にはSolr を選択します。リポジトリは先ほど作成したServiceDesk Plus に接続するリポジトリコレクションを選びます。
• 次に基本タブからジョブ実行を手動にするか、定期実行するかを自由に設定します。
• SQL タブでは、どんなデータを取得するのか、テーブル名やカラム、フィルタリング条件などを設定できます。CData JDBC ドライバがServiceDesk Plus のデータをテーブルにモデル化しているので、標準SQL でServiceDesk Plus をクエリすることができます。
  • SQL文：SELECT , FROM AnnouncementComments
  • キーカラム：Id など取得テーブルのキーとなるカラム
  • 検索対象カラム：検索の対象とするカラム
  • タイトルカラム：検索結果のタイトルとするカラム
  • タイムスタンプカラム：タイムスタンプとなるカラムがあれば、ここで指定します
  
• リクエストパラメータでは、検索結果レコードのURL （があれば）を設定することもできます。URL を表示できると表示された検索結果からレコードに簡単に移動できます。
• 取得元では、ラベルを設定しておきます。［更新］をクリックして、クローラージョブの設定を完了します。

Neuron でServiceDesk Plus のデータをクロールするジョブを実行

実際にNeuron で作成したジョブを実行します。［ジョブ］→［状態とジョブ管理］をクリックし、作成したジョブの［Start］をクリックします。

ジョブが正常完了すると、［Done］がステータスとして表示されます。

Neuron 上でのServiceDesk Plus のデータの検索の実施

実際にNeuron 上で検索ができるか確認してみます。取得元を絞り込むこと、内容やファイル名での検索、ファイルサイズやファイル更新日の絞り込み、部分一致や全部一致で検索が可能です。 検索をかけてみると、以下のようにデータを取得できました。

CData JDBC Driver for API をNeuron で使うことで、ServiceDesk Plus コネクタとして機能し、簡単にデータを取得して同期することができました。ぜひ、30日の無償評価版をお試しください。