FineReport で Yotpo のデータ を利用する
CData JDBC Driver for Yotpo は、JDBC 標準を完全に実装しており、さまざまなBI、レポート、ETL ツール、カスタムアプリケーションに Yotpo のデータ への接続を提供します。この記事では、FineReport で Yotpo のデータ をJDBC データソースとして設定し、レポートデザイナーで Yotpo のデータ をテーブルとして表示する方法を説明します。
Yotpo のデータ のJDBC データソースをセットアップする
以下の手順に従って、FineReport のデータベース接続として Yotpo のデータ を設定します。
- CData JDBC Driver for Yotpo のインストールディレクトリにあるlib フォルダから、cdata.jdbc.api.jar ファイルをFineReport のインストールディレクトリにあるlib フォルダにコピーします。cdata.jdbc.api.lic ファイルも同様にコピーしてください。
- ServerタブからDefine Data Connectionを選択し、クリックして新しい接続を追加してJDBCをクリックします。
続いて、ウィンドウでデータ接続の定義を設定します。
- Database: Others
- JDBC Driver: cdata.jdbc.api.APIDriver
-
URL: セミコロン区切りの接続プロパティを使用した標準のJDBC 接続文字列を入力します。
まず、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; - Connection pool attributesをクリックし、Test before getting connectionsをNoに設定します。
Test connectionをクリックして、接続が正しく設定されていることを確認します。これで、Yotpo への接続を設定し、FineReport のデータソースとして使用できるようになります。
レポートデザイナーで Yotpo のデータ を選択する
- クリックして新しいテンプレートデータセットを追加し、DB queryを選択してデータベースクエリウィンドウを開きます。
- ドロップダウンリストから、作成したJDBC 接続を選択します。
- 左ペインにYotpo のエンティティがテーブルとして表示されます。
- ロードするYotpo のデータ のテーブルとカラムに対してSELECT 文を記述します。
- プレビューをクリックすると、データがテーブルとして表示されます。
このように簡単な手順で、FineReport で Yotpo をJDBC データソースとして利用できるようになります。