JReport Designer でSquare のデータを連携

JReport Designer でSquare に連携するチャートとレポートを作成します。

加藤龍彦
デジタルマーケティング
最終更新日：2022-10-10

この記事で実現できるSquare 連携のシナリオ

CData

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

CData JDBC Driver for Square を使用すると、Square がリレーショナルデータベースであるかのようにダッシュボードやレポートからリアルタイムデータにアクセスでき、使い慣れたSQL クエリを使用してSquare] をクエリできます。ここでは、JDBC データソースとしてSquare に連携し、JReport Designer でSquare のレポートを作成する方法を説明します。

Square のデータに接続

C:\JReport\Designer\bin\setenv.bat を編集し、JAR ファイルの場所をADDCLASSPATH 変数に追加します。

...
set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Square 2016\lib\cdata.jdbc.square.jar;
...

［File］［New］［Data Source］と進み、新しいデータソースを作成します。
表示されるダイアログで、データソースの名前(CData JDBC Driver for Square) を作成し、JDBC を選択して［OK］をクリックします。
［JDBC Connection Information］ダイアログで、JDBC ドライバーへの接続を構成します。
- Driver:［Driver］ボックスにチェックがついていることを確認し、ドライバーのクラスの名前を入力します。 cdata.jdbc.square.SquareDriver
- URL:jdbc:square: から始まり、その後にセミコロンで区切られた接続プロパティのリストが続く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 接続プロパティを設定することもできます。これによって戻される行数を制限するため、可視化・レポートのデザイン設計時のパフォーマンスを向上させるのに役立ちます。
  
  以下は一般的なJDBC URLです。
  jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;InitiateOAuth=GETANDREFRESH
- User:認証に使用するユーザー名は、通常空白のままにします。
- Password:User と同様に認証に使用するパスワードも、通常は空白のままにします。
［Add Table］ダイアログで、レポート（またはこのデータソースを使用する予定のレポート）に含めるテーブルを選択し、［Add］をクリックします。

ダイアログがテーブルのロードを完了したら、［Done］をクリックします。
［Catalog Browser］では、レポートの作成に使用するクエリを作成できます。今すぐ、またはレポートの作成後に作成できますが、どちらにしても、データソース(CData JDBC Driver for Square) を展開()し、［Queries］を右クリックして［Add Query］を選択します。
［Add Table/View/Query］ダイアログで、JDBC URL とTables を展開() し、クエリで使用するテーブルを選択して［OK］をクリックします。
［Query Editor］ダイアログで、含めるカラムを選択するか、［SQL］ボタンをクリックして以下のようにカスタムクエリを手動で入力できます。
```
SELECT Reason, RefundedMoneyAmount FROM Refunds
```
クエリが作成されたら、［OK］をクリックして［Query Editor］ダイアログを閉じます。この時点で、Square を新規または既存のレポートに追加する準備が整いました。

NOTE: クエリが作成されると、クエリに基づいて［Business View］を作成できます。［Business View］を使用すると、クエリに基づいてWeb レポートまたはライブラリコンポーネントを作成できます。これについてのより詳しい情報は、JReport のチュートリアルを参照してください。