Jaspersoft Studio からGMO MakeShop のデータに接続する方法

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

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

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

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

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.gmomakeshop.GMOMakeShopDriver を入力。

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

     jdbc:gmomakeshop:ShopId=MyShopId;ProductsAccessCode=MyProductsAccessCode;MembersAccessCode=MyMembersAccessCode;OrdersAccessCode=MyOrdersAccessCode;

     GMO MakeShop に接続するには、MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId が必要です。

     GMO MakeShop へのアクセスの設定

     MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId を取得するには、以下の手順に従ってください。

     • GMO MakeShop には各API のAccessCode が必要です。
     • GMO MakeShop Store Manager にログインし、メニューの「ショップ作成」をクリックします。
     • 左ナビゲーションメニューの「外部システム連携」から任意の連携対象設定ををクリックします（メニューに表示されない場合は別途GMO MakeShop にご確認ください）。
     • 商品データ連携設定の場合：認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。
     • 注文データ連携設定の場合：最初に「注文情報参照」と「注文情報変更」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、OrdersAccessCode を取得します。
     • 会員データ連携設定の場合：最初に「会員情報の（参照・登録・変更・削除）」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、MembersAccessCode を取得します。
     • 会員認証連携設定の場合：認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。

     GMO MakeShop アカウントの認証

     次の接続プロパティを設定して接続します。

     • ShopId：接続先のGMO MakeShop Store ID を設定。GMO MakeShop Store ID はログイン用の ID と同じです。
     • OrdersAccessCode：「注文データ連携設定」から取得した「認証コード」を設定。このプロパティは Orders テーブルにアクセスする場合に必要です。
     • ProductsAccessCode：「商品データ連携設定」から取得した「認証コード」を設定。このプロパティは Products テーブルにアクセスする場合に必要です。
     • MembersAccessCode：「会員データ連携設定」から取得した「認証コード」を設定。このプロパティは Members テーブルにアクセスする場合に必要です。
     • MemberAuthenticationCode：「会員認証連携設定」から取得した「認証コード」を設定。このプロパティは MemberAuthenticationConfirm を実行する場合に必要です。
     • Password：GMO MakeShop Store Manager のログインユーザーのパスワードを指定。このプロパティは ProductCategoryRegistrationOrModification,ProductMemberGroupPriceRegistrationOrModification,ProductOptionRegistrationOrModification,ProductRegistrationOrModification を実行する場合に必要です。

GMO MakeShop データ で帳票を作成

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

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

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

チャートを追加

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

1. ［Design］タブをクリックします。
2. ［Outline］ビューで、帳票のルートノードを右クリックし［Create Dataset］をクリックします。
3. データセット名を入力し、オプションをクリックして接続またはデータソースから新しいデータセットを作成します。
4. ［Data Adapter］メニューで、最初のセクションで作成した［Data Adapter］を選択します。
5. 次のクエリを入力します：
   SELECT BrandCode, Price FROM Products
6. データセットに必要なフィールドを選択します。この例ではすべてのフィールドを使います。
7. カラムでグループ化する手順はスキップします。GMO MakeShop 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］が表示されたら、カラムをダブルクリックして各カラム値に新しいシリーズを作成します。例：BrandCode。シリーズをBrandCode に設定した場合、BrandCode ごとに新しい棒グラフが作成されます。
8. ［Value］ボックスの隣にあるボタンをクリックし、チャートのmeasures 用に［Expression Editor］を開きます。カラムをダブルクリックしてy 軸に追加します。例：Price。
9. ［Label］ボックスの隣にあるボタンをクリックし、チャートのdimensions 用に［Expression Editor］を開きます。カラムをダブルクリックしてx 軸に追加します。例：BrandCode。
10. この例ではカテゴリを使用しないため、［Category］ボックスに空の文字列 "" を入力します。

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

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

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