JReport Designer で freee Ordering のデータを連携利用

CData JDBC Driver for freee Ordering のデータ を使えば、ダッシュボードやレポートから freee Ordering をリレーショナルデータベースのように扱い、使い慣れた SQL クエリで freee Ordering のデータ のライブデータにアクセスできます。この記事では、JReport Designer で freee Ordering のデータ に JDBC データソースとして接続し、freee Ordering のデータ のデータをもとにレポートを作成する方法を説明します。

freee Ordering ののデータに接続

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

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

2. File メニューから New、Data Source と進み、新しいデータソースを作成します。
3. 表示されるダイアログでデータソース名を入力し（例：CData JDBC Driver for freee Ordering）、JDBC を選択して OK をクリックします。
4. Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
   • Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。

     cdata.jdbc.api.APIDriver

   • URL: JDBC URL を入力します。URL は jdbc:api: から始まり、その後に接続プロパティをセミコロン区切りで記述します。

     まずは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 Ordering JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。

     java -jar cdata.jdbc.api.jar
     

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

     

     JDBC URL を設定する際には、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限され、レポートやビジュアライゼーションのデザイン時のパフォーマンス向上に役立ちます。

     一般的な JDBC URL は次のとおりです。

     jdbc:api:Profile=freeedp.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

   • User: 認証に使用するユーザー名です。通常は空白のままにします。
   • Password: 認証に使用するパスワードです。通常は空白のままにします。
   

5. Add Table ダイアログで、レポートに含めるテーブル（または、このデータソースを使用する今後のレポート用のテーブル）を選択し、Add をクリックします。

   

   テーブルの読み込みが完了したら Done をクリックします。

6. Catalog Browser で、レポートを作成するためのクエリを作成できます。これはレポート作成前でも作成後でも行えます。データソース（CData JDBC Driver for freee Ordering）を展開（）し、Queries を右クリックして Add Query を選択します。
7. Add Table/View/Query ダイアログで、JDBC URL と Tables を展開（）し、クエリで使用するテーブルを選択して OK をクリックします。
8. Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。

   SELECT Id, DueDate FROM Deals
   

   

   クエリが構築できたら、OK をクリックして Query Editor ダイアログを閉じます。これで freee Ordering のデータ を新規または既存のレポートに追加する準備が整いました。

   NOTE: クエリが構築できたら、そのクエリをもとに Business View を作成できます。Business View を使用すると、クエリに基づいた Web レポートやライブラリコンポーネントを作成できます。詳しくは、JReport のチュートリアルを参照してください。

freee Ordering ののデータをレポートに追加

これで freee Ordering のデータ を使用したレポートを作成する準備が整いました。

1. File メニューから New、Page Report と進んで新しいレポートを作成するか、既存のレポートの Chart Wizard を開きます。
2. Query を選択します（または新規作成します。上記を参照）。

3. クエリのカラムからチャートの Category と Value を設定し、Finish をクリックします。

4. レポートの View タブをクリックして、チャートを表示します。