Jaspersoft Studio から Adobe Commerce のデータに接続
この記事では、CData JDBC Driver for Adobe Commerce を使って、Jaspersoft Studio からAdobe Commerce に標準JDBC データソースとして接続する方法を説明します。標準のJaspersoft ウィザードを使ってAdobe Commerce へのSQL クエリを作成していきます。クエリは直接Adobe Commerce API に実行されるため、Adobe Commerce のデータへのリアルタイム接続が可能になります。
Adobe Commerce のデータにJDBC データソースとして接続
Jaspersoft Studio でJDBC データソースを作成するには、データアダプタを作成します。
- Repository Explorer ビューで、Data Adapters ノードを右クリックし、Create Data Adapter をクリックします。
- Database JDBC Connection を選択します。
- ドライバーのわかりやすい名前を入力します。
- Driver Classpath タブで、Add をクリックします。表示されたダイアログで、インストールディレクトリのlib サブフォルダに移動し、ドライバーJAR を選択します。
- Database Location タブで、JDBC ドライバーのクラス名を入力します:cdata.jdbc.adobecommerce.AdobeCommerceDriver
- 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 接続プロパティも設定できます。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時のパフォーマンス向上に役立ちます。
以下はAdobe Commerce の一般的なJDBC URL です:
jdbc:adobecommerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myadobecommercehost.com;
-
Adobe Commerce のデータでレポートを作成
以下のステップに従って、Adobe Commerce へのSQL クエリを作成します。これはシンプルなレポートの基礎となります。
- File -> New Jasper Report をクリックします。テンプレートを選択し、親プロジェクトを選択して、レポートファイルを指定します。
- Data Adapter メニューで、前のセクションで作成したデータアダプタを選択します。
- Diagram タブで、テーブルをボックスにドラッグして、使用したいカラムをクリックします。または、Texts タブでカスタムクエリを入力します。例:
SELECT Name, Price FROM Products
- データセットに含めるフィールドを選択します。この例では、すべてのフィールドを使用します。
- Group By ステップをスキップして、ウィザードを完了します。
Preview タブで、現在のAdobe Commerce のデータでレポートがどのように表示されるかをプレビューできます。
チャートを作成
以下のセクションでは、独自のSQL クエリに紐づいたチャートを作成する方法を説明します。リモートデータソースからデータを取得する際、特定のレポートオブジェクト用に作成したより制限的なクエリを使用すると、パフォーマンスが向上する場合があります。
DataSet を作成
以下のステップに従って、チャートを入力する新しいデータセットを作成します。
- レポートの編集エリアで、Design タブをクリックします。
- Outline ビューで、レポートのルートノードを右クリックし、Create Dataset をクリックします。
- データセットの名前を入力し、接続またはデータソースから新しいデータセットを作成するオプションをクリックします。
- Data Adapter メニューで、最初のセクションで作成したデータアダプタを選択します。
- 次のようなクエリを入力します:
SELECT Name, Price FROM Products
- データセットに含めるフィールドを選択します。この例ではName とPrice を使用します。
- フィールドによるグループ化のステップをスキップして、ウィザードを完了します。
チャートを構成
データセットを追加した後、以下のステップに従ってチャートウィザードでカラム値をチャートの軸にマッピングします。
- Outline ビューでSummary ノードをクリックします。Properties ビューで、高さを400ピクセルに設定します。Summary バンドはレポートの最後に印刷されます。
- パレットからチャートをSummary にドラッグします。チャートウィザードが表示されます。
- チャートのタイプを選択します。この例では棒グラフを使用します。
- Dataset メニューで、チャート用に作成したデータセットを選択します。
- Dataset タブで、マスターレポートの入力に使用されたものと同じJDBC 接続を使用するオプションを選択します。
- チャートのシリーズを指定します:Series メニューの横にあるボタンをクリックし、Add をクリックします。表示されたExpression Editor で、Name カラムをダブルクリックして、式を$F{Name} に設定します。
y 軸の値を指定します:チャートウィザードで、Value ボックスの横にあるボタンをクリックします。Expression Editor で、Price をダブルクリックして、式を$F{Price} に設定します。
- シリーズ要素のラベルを指定します:チャートウィザードで、Label ボックスの横にあるボタンをクリックします。Expression Editor で、Name カラムをダブルクリックして、式を$F{Name} に設定します。必要に応じて、以下の式のようにカラムの型を文字列に変換します:
$F{Name}.toString()
- チャートを拡大してSummary セクションを埋めます:チャートを右クリックして、Size to Container -> Fit Both をクリックします。
レポートの実行
他のJDBC データソースと同様に、Adobe Commerce のデータでレポートを生成できるようになりました。Jaspersoft Studio はレポートの実行ごとにデータを定期的に更新します。