Jaspersoft Studio から BigCommerce のデータに接続

この記事では、CData JDBC Driver for BigCommerce を使って、Jaspersoft Studio からBigCommerce に標準JDBC データソースとして接続する方法を説明します。標準のJaspersoft ウィザードを使ってBigCommerce へのSQL クエリを作成していきます。クエリは直接BigCommerce API に実行されるため、BigCommerce のデータへのリアルタイム接続が可能になります。

BigCommerce のデータにJDBC データソースとして接続

Jaspersoft Studio でJDBC データソースを作成するには、データアダプタを作成します。

1. Repository Explorer ビューで、Data Adapters ノードを右クリックし、Create Data Adapter をクリックします。
2. Database JDBC Connection を選択します。
3. ドライバーのわかりやすい名前を入力します。
4. Driver Classpath タブで、Add をクリックします。表示されたダイアログで、インストールディレクトリのlib サブフォルダに移動し、ドライバーJAR を選択します。
5. Database Location タブで、JDBC ドライバーのクラス名を入力します：cdata.jdbc.bigcommerce.BigCommerceDriver
6. JDBC URL を入力します。

   BigCommerce 認証は標準のOAuth フローに基づいています。

   Store ID の取得

   BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

   1. BigCommerce アカウントにログインします。
   2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
   3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
   4. 画面にAPI Path という名前のテキストボックスが表示されます。
   5. テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
   6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
   7. Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

   パーソナルアクセストークンの取得

   加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

   1. BigCommerce アカウントにログインします。
   2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
   3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
   4. アカウント名を入力します。
   5. 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
   6. 「保存」をクリックします。

   BigCommerce への認証

   次に、以下を設定してデータに接続できます。
   • StoreId：API Path テキストボックスから取得したStore ID に設定。
   • OAuthAccessToken：生成したトークンに設定。
   • InitiateOAuth：OFF に設定。

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

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

   java -jar cdata.jdbc.bigcommerce.jar
   

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

   

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

   以下はBigCommerce の一般的なJDBC URL です：

   jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'
   

   

BigCommerce のデータでレポートを作成

以下のステップに従って、BigCommerce へのSQL クエリを作成します。これはシンプルなレポートの基礎となります。

1. File -> New Jasper Report をクリックします。テンプレートを選択し、親プロジェクトを選択して、レポートファイルを指定します。
2. Data Adapter メニューで、前のセクションで作成したデータアダプタを選択します。
3. Diagram タブで、テーブルをボックスにドラッグして、使用したいカラムをクリックします。または、Texts タブでカスタムクエリを入力します。例：

   SELECT FirstName, LastName FROM Customers WHERE FirstName = 'Bob'
   

   
4. データセットに含めるフィールドを選択します。この例では、すべてのフィールドを使用します。
5. Group By ステップをスキップして、ウィザードを完了します。

Preview タブで、現在のBigCommerce のデータでレポートがどのように表示されるかをプレビューできます。

チャートを作成

以下のセクションでは、独自のSQL クエリに紐づいたチャートを作成する方法を説明します。リモートデータソースからデータを取得する際、特定のレポートオブジェクト用に作成したより制限的なクエリを使用すると、パフォーマンスが向上する場合があります。

DataSet を作成

以下のステップに従って、チャートを入力する新しいデータセットを作成します。

1. レポートの編集エリアで、Design タブをクリックします。
2. Outline ビューで、レポートのルートノードを右クリックし、Create Dataset をクリックします。
3. データセットの名前を入力し、接続またはデータソースから新しいデータセットを作成するオプションをクリックします。
4. Data Adapter メニューで、最初のセクションで作成したデータアダプタを選択します。
5. 次のようなクエリを入力します：

   SELECT FirstName, LastName FROM Customers WHERE FirstName = 'Bob'
   

   
6. データセットに含めるフィールドを選択します。この例ではFirstName とLastName を使用します。
7. フィールドによるグループ化のステップをスキップして、ウィザードを完了します。

チャートを構成

データセットを追加した後、以下のステップに従ってチャートウィザードでカラム値をチャートの軸にマッピングします。

1. Outline ビューでSummary ノードをクリックします。Properties ビューで、高さを400ピクセルに設定します。Summary バンドはレポートの最後に印刷されます。
2. パレットからチャートをSummary にドラッグします。チャートウィザードが表示されます。
3. チャートのタイプを選択します。この例では棒グラフを使用します。
4. Dataset メニューで、チャート用に作成したデータセットを選択します。
5. Dataset タブで、マスターレポートの入力に使用されたものと同じJDBC 接続を使用するオプションを選択します。
6. チャートのシリーズを指定します：Series メニューの横にあるボタンをクリックし、Add をクリックします。表示されたExpression Editor で、FirstName カラムをダブルクリックして、式を$F{FirstName} に設定します。

7. y 軸の値を指定します：チャートウィザードで、Value ボックスの横にあるボタンをクリックします。Expression Editor で、LastName をダブルクリックして、式を$F{LastName} に設定します。

8. シリーズ要素のラベルを指定します：チャートウィザードで、Label ボックスの横にあるボタンをクリックします。Expression Editor で、FirstName カラムをダブルクリックして、式を$F{FirstName} に設定します。必要に応じて、以下の式のようにカラムの型を文字列に変換します：

   $F{FirstName}.toString()
   

   
9. チャートを拡大してSummary セクションを埋めます：チャートを右クリックして、Size to Container -> Fit Both をクリックします。

レポートの実行

他のJDBC データソースと同様に、BigCommerce のデータでレポートを生成できるようになりました。Jaspersoft Studio はレポートの実行ごとにデータを定期的に更新します。