Pentaho Report Designer でYotpo のデータを連携利用

CData JDBC Driver for Yotpo のデータ を使えば、ダッシュボードやレポートからリアルタイムデータにアクセスできます。この記事では、Yotpo のデータにJDBC データソースとして接続し、Pentaho でYotpo のデータをもとにしたレポートを公開する方法を説明します。

接続してレポートを作成

1. インストールディレクトリのlib サブフォルダ内にあるドライバーのJAR ファイルを、Pentaho ディレクトリ内の\Report-Designer\lib\jdbc\ フォルダにコピーします。
2. \Report-Designer\ フォルダ内のreport-designer.bat ファイルを実行してReport-Designer UI を開きます。

3. Data -> Add Data Source -> Advanced -> JDBC（Custom）をクリックし、新しいYotpo 接続を作成して、ドライバーで新しいデータソースを作成します。 表示されるダイアログで、以下のように接続プロパティを設定します。

   • Custom Connection URL property：JDBC URL を入力します。JDBC URL はjdbc:api: で始まり、その後にセミコロン区切りで接続プロパティを指定します。

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

     Yotpo API プロファイル設定

     Yotpo への認証には、Yotpo の AppKey と AppSecret を使った OAuth 2.0 クライアントクレデンシャルフローを利用できます。

     Yotpo API を使用するには、AppKey と AppSecret を持つ Yotpo ストアアカウントが必要です。これらの認証情報は、Yotpo ダッシュボードの「Account Settings」>「Store」で確認できます。

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

     • AuthScheme：OAuthClient に設定します。
     • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
     • OAuthClientId：Yotpo の AppKey に設定します。
     • OAuthClientSecret：Yotpo の AppSecret に設定します。

     組み込みの接続文字列デザイナー

     JDBC URL の構成については、Yotpo JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。

     
     java -jar cdata.jdbc.api.jar
     

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     

     JDBC URL を設定する際、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限されます。特にレポートやビジュアライゼーションを設計する際のパフォーマンス向上に役立ちます。

     一般的なJDBC URL は次のとおりです：

     jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;

   • Custom Driver Class Name：cdata.jdbc.api.APIDriver を入力します。
   • User Name：認証に使用するユーザー名。
   • Password：認証に使用するパスワード。
   

レポートにYotpo のデータを追加

Yotpo のデータをもとにレポートを作成する準備が整いました。

1. レポートにYotpo のソースを追加します。Data -> Add Data Source -> JDBC をクリックしてデータソースを選択します。

2. クエリを設定します。この記事では以下のクエリを使用します：

   SELECT TotalReview, AverageScore FROM ProductBottomLine WHERE ExternalProductId = 'my-product-sku'

   
3. レポートにチャートをドラッグし、ダブルクリックしてチャートを編集します。レポートを実行してチャートを表示します。このクエリの結果を使用して、ProductBottomLine テーブルのシンプルなチャートを作成できます。
4. 最後に、レポートを実行してチャートを確認します。