BIRT でfreee のデータのレポートを作成
CData JDBC Driver for freee は、データドリブンな Java アプリケーションにfreee API への接続機能を統合します。CData JDBC Driver for freee を BIRT(Business Intelligence Reporting Tools)プラットフォームと組み合わせることで、データの変更をリアルタイムに反映する BIRT レポートを作成できます。
- まだインストールしていない場合は、BIRT Framework プラグインと Database Development プラグインを Eclipse にインストールします。
- 「File」->「New」->「Report」をクリックします。Report Design パースペクティブが開きます。
- Data Explorer で「Data Sources」を右クリックし、「New Data Source」をクリックします。
- 「Create from a Data Source Type in the Following List」オプションを選択し、「JDBC Data Source」を選択します。
- 「Manage Drivers」をクリックし、インストールフォルダの lib サブフォルダにあるドライバー JAR を追加します。
- 「Database URL」ボックスに、接続文字列を含む 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;
- 「Data Sets」フォルダを右クリックし、freee用の JDBC データソースを選択します。
- 表示されるダイアログで、レポート用のデータを取得する SELECT クエリを作成します。この記事では以下のクエリを使用します:
SELECT Amount, IssueDate FROM Deals
- 「Palette」からエディターにチャートをドラッグします。チャートウィザードが表示されます。
- チャートタイプを選択した後、「Select Data」タブでカラムをチャートフィールドにドラッグします。
- 「Run」->「View Report」->「In Web Viewer」をクリックしてレポートを表示します。
これで、BIRT レポートがfreee のデータの更新を反映できるようになりました。
レポートをアプリケーションサーバーに公開するには、ドライバー JAR を BIRT Viewer のクラスパスに追加します。詳細については、Java アプリケーションサーバーへの JDBC ドライバのデプロイに関する CData KB ガイドを参照してください。