JReport Designer でfreee のデータを連携

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

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

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

CData

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

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

freee のデータに接続

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

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

［File］［New］［Data Source］と進み、新しいデータソースを作成します。
表示されるダイアログで、データソースの名前(CData JDBC Driver for API) を作成し、JDBC を選択して［OK］をクリックします。
［JDBC Connection Information］ダイアログで、JDBC ドライバーへの接続を構成します。
- Driver:［Driver］ボックスにチェックがついていることを確認し、ドライバーのクラスの名前を入力します。 cdata.jdbc.api.APIDriver
- URL:jdbc:api: から始まり、その後にセミコロンで区切られた接続プロパティのリストが続くJDBC URL を入力します。
  まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。
  
  次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」などに設置してください。
  
  その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。
  - AuthScheme：OAuth に設定します。
  - OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
  - OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
  - CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
  - InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
  ビルトイン接続文字列デザイナー
  
  JDBC URL の構成については、freee JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
  java -jar cdata.jdbc.api.jar
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  JDBC URL を構成する際、Max Rows 接続プロパティを設定することもできます。これによって戻される行数を制限するため、可視化・レポートのデザイン設計時のパフォーマンスを向上させるのに役立ちます。
  
  以下は一般的なJDBC URLです。
  jdbc:api:Profile=freee.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH
- User:認証に使用するユーザー名は、通常空白のままにします。
- Password:User と同様に認証に使用するパスワードも、通常は空白のままにします。
［Add Table］ダイアログで、レポート（またはこのデータソースを使用する予定のレポート）に含めるテーブルを選択し、［Add］をクリックします。

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

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