エンタープライズサーチのNeuron にShopify のデータを取り込んで検索利用
ブレインズテクノロジー社のNeuron は、先端OSS 技術(Apache Solr)を活用したエンタープライズサーチ(企業内検索エンジン)サービスです。Apache Solr は、エンタープライズサーチ機能をAPI として提供してくれますが、Neuron はApache Solr に企業ユーザーがデータを探索するためのシンプルかつ使いやすいユーザーインターフェースと管理画面・運用機能を提供してくれます。これによりエンドユーザーが簡単にエンタープライズサーチを利用することができます。管理画面では、ファイルやデータのクローリング設定がUI で行えるようになっています。この記事では、Neuron に備わっているJDBC インターフェース経由で、CData JDBC Driver for Shopify を利用することでNeuron にShopify のデータを取り込んで検索で利用できるようにします。
Neuron にCData JDBC Driver for Shopify データをロード
CData JDBC Driver for Shopify のインストールと.jar ファイルの配置
- CData JDBC Driver for Shopify をNeuron と同じマシンにインストールします。
-
以下のパスにJDBC Driver がインストールされます。
C:\Program Files\CData\CData JDBC Driver for Shopify 20xxJ\lib\cdata.jdbc.shopify.jar
-
このcdata.jdbc.shopify.jar とcdata.jdbc.shopify.lic ファイルをコピーして、Neuron のC:\APP
cf\lib フォルダに配置します。
Neuron CF でのShopify のデータを扱うリポジトリの作成
-
Neuron CF でクローラーの設定をGUI で行います。JDBC を読み取るためのリポジトリを作成します。Neuron の管理画面にログインし、[リポジトリ]→[リポジトリコレクション一覧]→[新規]をクリックします。
-
任意のリポジトリ名を入力します。タイプは[JDBC]を選択します。
-
次に、ドライバーのクラス名とJDBC 接続文字列でShopify への接続を行います。
それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。
アクセストークンによる接続
アクセストークン経由の接続には、以下の2つのステップが必要です。
- Shopify の管理画面でアクセストークンを作成
- アクセストークンを使用して認証
アクセストークンの作成
まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。
- 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
- Develop apps をクリックしてCreate an app を選択します
- Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
- Save をクリックします
- Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです:
- unauthenticated_read_content
- Save をクリックします
- API Credentials を選択します
- "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
- Admin API Access token のアクセストークンをコピーします。注意:トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください
アクセストークンによる認証
続いて、アクセストークンで認証するには、以下のプロパティを設定してください。
- AuthScheme:AccessToken に設定
- AccessToken:カスタムアプリからコピーしたアクセストークンの値に設定
OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。
ドライバクラス名:cdata.jdbc.shopify.ShopifyDriver
接続文字列:jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;
- [更新]をクリックして、Shopify に接続するリポジトリコレクションができました。
Neuron でShopify のデータをクローリングするジョブを作成
続いて、Shopify のどのデータをどのようにクローリングするのかをジョブで定義していきます。
-
管理画面で[ジョブ]→[ジョブ一覧]→[新規]とクリックします。
-
任意のジョブ名を入力します。出力先にはSolr を選択します。リポジトリは先ほど作成したShopify に接続するリポジトリコレクションを選びます。
-
次に基本タブからジョブ実行を手動にするか、定期実行するかを自由に設定します。
-
SQL タブでは、どんなデータを取得するのか、テーブル名やカラム、フィルタリング条件などを設定できます。CData JDBC ドライバがShopify のデータをテーブルにモデル化しているので、標準SQL でShopify をクエリすることができます。
- SQL文:SELECT FirstName, Id FROM Customers
- キーカラム:Id など取得テーブルのキーとなるカラム
- 検索対象カラム:検索の対象とするカラム
- タイトルカラム:検索結果のタイトルとするカラム
- タイムスタンプカラム:タイムスタンプとなるカラムがあれば、ここで指定します
- リクエストパラメータでは、検索結果レコードのURL (があれば)を設定することもできます。URL を表示できると表示された検索結果からレコードに簡単に移動できます。
- 取得元では、ラベルを設定しておきます。[更新]をクリックして、クローラージョブの設定を完了します。
Neuron でShopify のデータをクロールするジョブを実行
実際にNeuron で作成したジョブを実行します。[ジョブ]→[状態とジョブ管理]をクリックし、作成したジョブの[Start]をクリックします。
ジョブが正常完了すると、[Done]がステータスとして表示されます。
Neuron 上でのShopify のデータの検索の実施
実際にNeuron 上で検索ができるか確認してみます。取得元を絞り込むこと、内容やファイル名での検索、ファイルサイズやファイル更新日の絞り込み、部分一致や全部一致で検索が可能です。 検索をかけてみると、以下のようにデータを取得できました。
CData JDBC Driver for Shopify をNeuron で使うことで、Shopify コネクタとして機能し、簡単にデータを取得して同期することができました。ぜひ、30日の無償評価版をお試しください。