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

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

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 でのApprovalMax のデータを扱うリポジトリの作成

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

  まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します（例：C:\profiles\ApprovalMax.apip）。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します（以下を参照）。

  ApprovalMax API プロファイル設定

  ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。

  まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal（https://developer.approvalmax.com/applications）にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI（Callback URL）を少なくとも1つ登録しておく必要があります。

  Public API を利用するには、ApprovalMax の Premium サブスクリプション（または有効なトライアル）が必要です。

  以下の接続プロパティを設定すると、接続できるようになります。

  • AuthScheme：OAuth に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId：ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
  • OAuthClientSecret：ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
  • CallbackURL：アプリケーション設定で登録した Redirect URI に設定します。
  • Scope：（オプション）デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。

  OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。

  
  ドライバクラス名：cdata.jdbc.api.APIDriver
  接続文字列：jdbc:api:Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;InitiateOAuth=REFRESH
• ［更新］をクリックして、ApprovalMax に接続するリポジトリコレクションができました。

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

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

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

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

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

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

Neuron 上でのApprovalMax のデータの検索の実施

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

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