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

Jerod Johnson
Senior Technology Evangelist

JReport Designer で Adobe Commerce のデータをもとにチャートとレポートを作成。

CData JDBC Driver for Adobe Commerce のデータを使えば、ダッシュボードやレポートから Adobe Commerce をリレーショナルデータベースのように扱い、使い慣れた SQL クエリで Adobe Commerce のデータのライブデータにアクセスできます。この記事では、JReport Designer で Adobe Commerce のデータに JDBC データソースとして接続し、Adobe Commerce のデータのデータをもとにレポートを作成する方法を説明します。

Adobe Commerce ののデータに接続

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

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

File メニューから New、Data Source と進み、新しいデータソースを作成します。
表示されるダイアログでデータソース名を入力し（例：CData JDBC Driver for Adobe Commerce）、JDBC を選択して OK をクリックします。
Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
- Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
```
cdata.jdbc.adobecommerce.AdobeCommerceDriver
```
- URL: JDBC URL を入力します。URL は jdbc:adobecommerce: から始まり、その後に接続プロパティをセミコロン区切りで記述します。
  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;
```
- User: 認証に使用するユーザー名です。通常は空白のままにします。
- Password: 認証に使用するパスワードです。通常は空白のままにします。
Add Table ダイアログで、レポートに含めるテーブル（または、このデータソースを使用する今後のレポート用のテーブル）を選択し、Add をクリックします。

テーブルの読み込みが完了したら Done をクリックします。
Catalog Browser で、レポートを作成するためのクエリを作成できます。これはレポート作成前でも作成後でも行えます。データソース（CData JDBC Driver for Adobe Commerce）を展開（）し、Queries を右クリックして Add Query を選択します。
Add Table/View/Query ダイアログで、JDBC URL と Tables を展開（）し、クエリで使用するテーブルを選択して OK をクリックします。
Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。
```
SELECT Name, Price FROM Products
```
クエリが構築できたら、OK をクリックして Query Editor ダイアログを閉じます。これで Adobe Commerce のデータを新規または既存のレポートに追加する準備が整いました。

NOTE: クエリが構築できたら、そのクエリをもとに Business View を作成できます。Business View を使用すると、クエリに基づいた Web レポートやライブラリコンポーネントを作成できます。詳しくは、JReport のチュートリアルを参照してください。