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

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
Jaspersoft Studio でSquare のデータにSQL を実行。

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

Square のデータに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.square.SquareDriver
  6. JDBC URL を入力します。

    Square OAuth 認証標準を使用します。OAuth を使用して認証するには、Square にアプリを登録してOAuthClientId、OAuthClientSecret、CallbackURL を入手します。OAuth の使用方法については、ヘルプドキュメントの「はじめに」セクションをご覧ください。

    追加でLocationId を指定する必要がある場合があります。Locations テーブルをクエリすることでLocations のId を取得できます。または、クエリの検索項目にLocationId を設定することもできます。

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

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

    java -jar cdata.jdbc.square.jar
    

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

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

    以下はSquare の一般的なJDBC URL です:

    jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;
    

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

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

  1. File -> New Jasper Report をクリックします。テンプレートを選択し、親プロジェクトを選択して、レポートファイルを指定します。
  2. Data Adapter メニューで、前のセクションで作成したデータアダプタを選択します。
  3. Diagram タブで、テーブルをボックスにドラッグして、使用したいカラムをクリックします。または、Texts タブでカスタムクエリを入力します。例:
    SELECT Reason, RefundedMoneyAmount FROM Refunds
    
  4. データセットに含めるフィールドを選択します。この例では、すべてのフィールドを使用します。
  5. Group By ステップをスキップして、ウィザードを完了します。

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

チャートを作成

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

DataSet を作成

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

  1. レポートの編集エリアで、Design タブをクリックします。
  2. Outline ビューで、レポートのルートノードを右クリックし、Create Dataset をクリックします。
  3. データセットの名前を入力し、接続またはデータソースから新しいデータセットを作成するオプションをクリックします。
  4. Data Adapter メニューで、最初のセクションで作成したデータアダプタを選択します。
  5. 次のようなクエリを入力します:
    SELECT Reason, RefundedMoneyAmount FROM Refunds
    
  6. データセットに含めるフィールドを選択します。この例ではReason とRefundedMoneyAmount を使用します。
  7. フィールドによるグループ化のステップをスキップして、ウィザードを完了します。

チャートを構成

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

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

  8. シリーズ要素のラベルを指定します:チャートウィザードで、Label ボックスの横にあるボタンをクリックします。Expression Editor で、Reason カラムをダブルクリックして、式を$F{Reason} に設定します。必要に応じて、以下の式のようにカラムの型を文字列に変換します:
    $F{Reason}.toString()
    
  9. チャートを拡大してSummary セクションを埋めます:チャートを右クリックして、Size to Container -> Fit Both をクリックします。

レポートの実行

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

はじめる準備はできましたか?

Square Driver の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

Square Icon Square JDBC Driver お問い合わせ

Square のTransaction、Items、Subscriptions データをJava ベースのアプリケーションから手軽に連携。