JReport Designer でAdobe Commerce のデータを連携

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for AdobeCommerce を使用すると、Adobe Commerce がリレーショナルデータベースであるかのようにダッシュボードやレポートからリアルタイムデータにアクセスでき、使い慣れたSQL クエリを使用してAdobe Commerce] をクエリできます。ここでは、JDBC データソースとしてAdobe Commerce に連携し、JReport Designer でAdobe Commerce のレポートを作成する方法を説明します。

Adobe Commerce のデータに接続

1. C:\JReport\Designer\bin\setenv.bat を編集し、JAR ファイルの場所をADDCLASSPATH 変数に追加します。

   ...
   set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for AdobeCommerce 2016\lib\cdata.jdbc.adobecommerce.jar;
   ...
   

2. ［File］［New］［Data Source］と進み、新しいデータソースを作成します。
3. 表示されるダイアログで、データソースの名前(CData JDBC Driver for AdobeCommerce) を作成し、JDBC を選択して［OK］をクリックします。
4. ［JDBC Connection Information］ダイアログで、JDBC ドライバーへの接続を構成します。
   • Driver:［Driver］ボックスにチェックがついていることを確認し、ドライバーのクラスの名前を入力します。 cdata.jdbc.adobecommerce.AdobeCommerceDriver
   • URL:jdbc:adobecommerce: から始まり、その後にセミコロンで区切られた接続プロパティのリストが続くJDBC URL を入力します。

     Adobe Commerce はOAuth 1 認証標準を使用します。Adobe Commerce REST API に接続するには、Adobe Commerce システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。

     また、Adobe Commerce システムへのURL を提供する必要があります。URL は、Adobe Commerce REST API を顧客として使用しているか管理者として使用しているかによって異なります。

     • Customer: Adobe Commerce を顧客として使用するには、事前にAdobe Commerce のホームページで顧客アカウントを作成します。これを行うには、「アカウント」->「登録」をクリックします。それからURL 接続プロパティをAdobe Commerce システムのエンドポイントに設定します。

     • Administrator: Adobe Commerce を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、「Admin」メニューの「Advanced」設定で取得できます。「System」->「Configuration」->「Advanced」->「Admin」->「Admin Base URL」を選択することでアクセスできます。

       このページ上の「Use Custom Admin Path」設定がYES に設定されている場合、値は「Custom Admin Path」テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。

     ビルトイン接続文字列デザイナー

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

     java -jar cdata.jdbc.adobecommerce.jar

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

     JDBC URL を構成する際、Max Rows 接続プロパティを設定することもできます。これによって戻される行数を制限するため、可視化・レポートのデザイン設計時のパフォーマンスを向上させるのに役立ちます。

     以下は一般的なJDBC URLです。

     jdbc:adobecommerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myadobecommercehost.com;InitiateOAuth=GETANDREFRESH
   • User:認証に使用するユーザー名は、通常空白のままにします。
   • Password:User と同様に認証に使用するパスワードも、通常は空白のままにします。

5. ［Add Table］ダイアログで、レポート（またはこのデータソースを使用する予定のレポート）に含めるテーブルを選択し、［Add］をクリックします。

   ダイアログがテーブルのロードを完了したら、［Done］をクリックします。

6. ［Catalog Browser］では、レポートの作成に使用するクエリを作成できます。今すぐ、またはレポートの作成後に作成できますが、どちらにしても、 データソース(CData JDBC Driver for Adobe Commerce) を展開()し、［Queries］を右クリックして［Add Query］を選択します。
7. ［Add Table/View/Query］ダイアログで、JDBC URL とTables を展開() し、クエリで使用するテーブルを選択して［OK］をクリックします。
8. ［Query Editor］ダイアログで、含めるカラムを選択するか、［SQL］ボタンをクリックして以下のようにカスタムクエリを手動で入力できます。

   SELECT Name, Price FROM Products
   

   クエリが作成されたら、［OK］をクリックして［Query Editor］ダイアログを閉じます。この時点で、Adobe Commerce を新規または既存のレポートに追加する準備が整いました。

   NOTE: クエリが作成されると、クエリに基づいて［Business View］を作成できます。［Business View］を使用すると、クエリに基づいてWeb レポートまたはライブラリコンポーネントを作成できます。これについてのより詳しい情報は、JReport のチュートリアルを参照してください。

レポートにAdobe Commerce のデータを追加

Adobe Commerce を使用してレポートを作成することができるようになりました。

1. 新しいレポートを作成(［File］［New］［Page Report］) するか、既存のレポートの［Chart Wizard］を開きます。
2. クエリを選択(または上記を参照して新しいクエリを作成) します。
3. クエリのカラムからグラフの［Category］と［Value］を割り当て、［Finish］をクリックします。
4. レポートの［View］タブをクリックし、チャートを表示します。