エンタープライズサーチのNeuron にStripe のデータを取り込んで検索利用
ブレインズテクノロジー社のNeuron は、先端OSS 技術(Apache Solr)を活用したエンタープライズサーチ(企業内検索エンジン)サービスです。Apache Solr は、エンタープライズサーチ機能をAPI として提供してくれますが、Neuron はApache Solr に企業ユーザーがデータを探索するためのシンプルかつ使いやすいユーザーインターフェースと管理画面・運用機能を提供してくれます。これによりエンドユーザーが簡単にエンタープライズサーチを利用することができます。管理画面では、ファイルやデータのクローリング設定がUI で行えるようになっています。この記事では、Neuron に備わっているJDBC インターフェース経由で、CData JDBC Driver for Stripe を利用することでNeuron にStripe のデータを取り込んで検索で利用できるようにします。
Neuron にCData JDBC Driver for Stripe データをロード
CData JDBC Driver for Stripe のインストールと.jar ファイルの配置
- CData JDBC Driver for Stripe をNeuron と同じマシンにインストールします。
-
以下のパスにJDBC Driver がインストールされます。
C:\Program Files\CData\CData JDBC Driver for Stripe 20xxJ\lib\cdata.jdbc.stripe.jar
-
このcdata.jdbc.stripe.jar とcdata.jdbc.stripe.lic ファイルをコピーして、Neuron のC:\APP
cf\lib フォルダに配置します。
Neuron CF でのStripe のデータを扱うリポジトリの作成
-
Neuron CF でクローラーの設定をGUI で行います。JDBC を読み取るためのリポジトリを作成します。Neuron の管理画面にログインし、[リポジトリ]→[リポジトリコレクション一覧]→[新規]をクリックします。
-
任意のリポジトリ名を入力します。タイプは[JDBC]を選択します。
-
次に、ドライバーのクラス名とJDBC 接続文字列でStripe への接続を行います。
Stripeへの接続
それでは、Stripe への接続について説明していきましょう。Stripe では、本番API キーまたはOAuth のいずれかによる認証をサポートしています。
本番API キー
本番API キーで接続するには、以下の2つの設定パラメータを設定する必要があります。
- AuthScheme = APIKey
- LiveAPIKey = 本番API キーの値
本番API キーの値を取得するには、以下の手順で確認できます:
- Stripe ダッシュボードにログインします
- 開発者 → API キー → シークレットキー → 本番環境のキーを表示 に移動します
Stripe では、テストモードで作成されたシークレットキーを使用して、'StripeV2' データモデルのエンティティにはアクセスできませんのでご注意ください。ライブモードまたはサンドボックスモードで作成されたシークレットキーをご利用ください。 さらに、制限付きキーを使用して'StripeV2' データモデルのエンティティにアクセスすることも許可されていません。
OAuth については、ヘルプドキュメントの「接続の確立」をご確認ください。
ドライバクラス名:cdata.jdbc.stripe.StripeDriver
接続文字列:jdbc:stripe:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=REFRESH
- [更新]をクリックして、Stripe に接続するリポジトリコレクションができました。
Neuron でStripe のデータをクローリングするジョブを作成
続いて、Stripe のどのデータをどのようにクローリングするのかをジョブで定義していきます。
-
管理画面で[ジョブ]→[ジョブ一覧]→[新規]とクリックします。
-
任意のジョブ名を入力します。出力先にはSolr を選択します。リポジトリは先ほど作成したStripe に接続するリポジトリコレクションを選びます。
-
次に基本タブからジョブ実行を手動にするか、定期実行するかを自由に設定します。
-
SQL タブでは、どんなデータを取得するのか、テーブル名やカラム、フィルタリング条件などを設定できます。CData JDBC ドライバがStripe のデータをテーブルにモデル化しているので、標準SQL でStripe をクエリすることができます。
- SQL文:SELECT Email, Discount FROM Customers
- キーカラム:Id など取得テーブルのキーとなるカラム
- 検索対象カラム:検索の対象とするカラム
- タイトルカラム:検索結果のタイトルとするカラム
- タイムスタンプカラム:タイムスタンプとなるカラムがあれば、ここで指定します
- リクエストパラメータでは、検索結果レコードのURL (があれば)を設定することもできます。URL を表示できると表示された検索結果からレコードに簡単に移動できます。
- 取得元では、ラベルを設定しておきます。[更新]をクリックして、クローラージョブの設定を完了します。
Neuron でStripe のデータをクロールするジョブを実行
実際にNeuron で作成したジョブを実行します。[ジョブ]→[状態とジョブ管理]をクリックし、作成したジョブの[Start]をクリックします。
ジョブが正常完了すると、[Done]がステータスとして表示されます。
Neuron 上でのStripe のデータの検索の実施
実際にNeuron 上で検索ができるか確認してみます。取得元を絞り込むこと、内容やファイル名での検索、ファイルサイズやファイル更新日の絞り込み、部分一致や全部一致で検索が可能です。 検索をかけてみると、以下のようにデータを取得できました。
CData JDBC Driver for Stripe をNeuron で使うことで、Stripe コネクタとして機能し、簡単にデータを取得して同期することができました。ぜひ、30日の無償評価版をお試しください。