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

こんにちは！リードエンジニアの杉本です。

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

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

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

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

Neuron CF でのJira Service Management のデータを扱うリポジトリの作成

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

  Jira Service Management 接続プロパティの取得・設定方法

  任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。

  • URL（例：https://yoursitename.atlassian.net）

  カスタムフィールドへのアクセス

  デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。

  Jira Service Management への認証

  ベーシック認証

  ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。

  • AuthScheme：Basic に設定。
  • User：認証ユーザーのユーザー名に設定。
  • Password：認証ユーザーのパスワードに設定。

  API トークン

  Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

  データに接続するには以下を設定します。

  • AuthScheme：APIToken に設定。
  • User：認証ユーザーのユーザー名に設定。
  • APIToken：作成したAPI トークンに設定。

  ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

  OAuth 2.0

  Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。

  この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。

  
  ドライバクラス名：cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
  接続文字列：jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;InitiateOAuth=REFRESH

• ［更新］をクリックして、Jira Service Management に接続するリポジトリコレクションができました。

Neuron でJira Service Management のデータをクローリングするジョブを作成

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

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

Neuron でJira Service Management のデータをクロールするジョブを実行

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

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

Neuron 上でのJira Service Management のデータの検索の実施

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

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