Jaspersoft Studio からBigCommerce データに接続する方法

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

この記事では、CData JDBC Driver for BigCommerce を使ってBigCommerce の連携機能を持つJaspersoft Studio の基本的な帳票をテーブルやチャートで作成する方法を説明します。レポートを実行するたびに、チャートおよびテーブルはリアルタイムデータを表示します。JasperSoft のウィザードを使って、レポートエレメントを埋めるSQL クエリをいくつかビルドします。ドライバーは、リレーショナルデータベースへのデータのコピー処理をスキップする間、標準SQL を利用可能にします。代わりに、クエリは基になるBigCommerce API に直接実行されます。

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

Jaspersoft Studio で、［Data Adapter］ウィザードを使ってJDBC データソースに接続できます。下記の手順に従って、プロジェクトからBigCommerce に接続します。BigCommerce データアダプターをワークスペースに追加します。

1. ［Repository Explorer］で［Data Apters］ノードを右クリックし、［Create Data Adapter］をクリックします。
2. ［Database JDBC Connection］を選択します。
3. ユーザーフレンドリーなドライバー名を入力します。
4. ［Driver Classpath］タブで［Add］をクリックします。ダイアログが表示されたら、インストールディレクトリの［lib］サブフォルダにナビゲートします。ドライバーのJAR を選択します。
5. ［Database Location］タブでは、以下の情報が必要です：
   • JDBC Driver：JDBC driver のクラス名cdata.jdbc.bigcommerce.BigCommerceDriver を入力。

   • JDBC URL：JDBC URL に必要な接続プロパティを入力。接続プロパティは、セミコロン区切りでname-value ペアを入力する必要があります。BigCommerce の一般的なJDBC URL は次のとおりです：

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

     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 に設定。

BigCommerce データ で帳票を作成

BigCommerce のデータアダプターを作成したら、BigCommerce データをJasperReports に追加できます。このセクションでは同梱されているテンプレートの一つをBigCommerce データに連携させる方法について説明します。

1. ［File］>［New Jasper Report］をクリックします。テンプレートを選択し、親プロジェクトを選択して、帳票に名前を入力します。
2. ［Data Adapter］ウィザードで、先のセクションで作成したデータアダプターを選択します。
3. ［Diagram］タブでは、クエリを視覚的にビルドできます：テーブルをボックスにドラッグしお好みのカラムをクリックします。カスタムクエリも入力可能です。例： SELECT * FROM Customers
4. データセットに含めたいフィールドを選択します。

［Preview］タブでは、最新のBigCommerce を使ったものと同じ帳票を見ることができます。

チャートを追加

下記の手順に従って、BigCommerce のチャートを既存の帳票に追加します。棒グラフを、先のセクションで作成した帳票テンプレートの最後に追加します。

1. ［Design］タブをクリックします。
2. ［Outline］ビューで、帳票のルートノードを右クリックし［Create Dataset］をクリックします。
3. データセット名を入力し、オプションをクリックして接続またはデータソースから新しいデータセットを作成します。
4. ［Data Adapter］メニューで、最初のセクションで作成した［Data Adapter］を選択します。
5. 次のクエリを入力します：
   SELECT FirstName, LastName FROM Customers WHERE FirstName = 'Bob'
6. データセットに必要なフィールドを選択します。この例ではすべてのフィールドを使います。
7. カラムでグループ化する手順はスキップします。BigCommerce API はGROUP BY のステートメントをサポートしていません。

データセットを追加したら、下記の手順に従ってチャートを作成します。

1. ［Outline］ビューの［Summary］ノードをクリックします。［Properties］ビューで高さを400ピクセルに設定します。サマリーバンドが帳票の最後にプリントされます。
2. チャートを［Palette］からsummary にドラッグします。Chart ウィザードが表示されます。
3. チャートの種類を選択します。この例では棒グラフを使います。
4. ［Dataset］メニューで、チャート用に作成したデータセットを選択します。
5. ［Dataset］タブで、オプションを選択してマスター帳票と同じ接続を使用します。Chart ウィザードは接続パラメータを入力し、メニューセレクションを［Use Another Connection］に変更します。
6. ［Series］メニューの隣にあるボタンをクリックし、デフォルトシリーズを削除します。［Add］をクリックします。
7. ［Expression Editor］が表示されたら、カラムをダブルクリックして各カラム値に新しいシリーズを作成します。例：FirstName。シリーズをFirstName に設定した場合、FirstName ごとに新しい棒グラフが作成されます。
8. ［Value］ボックスの隣にあるボタンをクリックし、チャートのmeasures 用に［Expression Editor］を開きます。カラムをダブルクリックしてy 軸に追加します。例：LastName。
9. ［Label］ボックスの隣にあるボタンをクリックし、チャートのdimensions 用に［Expression Editor］を開きます。カラムをダブルクリックしてx 軸に追加します。例：FirstName。
10. この例ではカテゴリを使用しないため、［Category］ボックスに空の文字列 "" を入力します。

チャートを作成したら基本的なフォーマットを行い、サブレポートをレポートに未使用スペースなくシームレスに追加できるようにします。

1. チャートを右クリックして［Size to Container］>［Fit Both］をクリックします。
2. メインレポートでサブレポートを右クリックして［Size to Container］>［Fit Both］をクリックします。

プレビューする前に帳票への変更を保存します。チャートが帳票の最後のページに表示されます。