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

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
JReport Designer で Clio のデータ をもとにチャートとレポートを作成。

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

Clio ののデータに接続

  1. C:\JReport\Designer\bin\setenv.bat を編集して、JAR ファイルの場所を ADDCLASSPATH 変数に追加します。
    ...
    set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Clio 2016\lib\cdata.jdbc.api.jar;
    ...
    
  2. File メニューから New、Data Source と進み、新しいデータソースを作成します。
  3. 表示されるダイアログでデータソース名を入力し(例:CData JDBC Driver for Clio)、JDBC を選択して OK をクリックします。
  4. Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
    • Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
      cdata.jdbc.api.APIDriver
    • URL: JDBC URL を入力します。URL は jdbc:api: から始まり、その後に接続プロパティをセミコロン区切りで記述します。

      まず、Profile 接続プロパティをディスク上のClio プロファイルの場所に設定します(例:C:\profiles\Clio.apip)。次に、ProfileSettings 接続プロパティをClio の接続文字列に設定します(以下を参照)。

      Clio API プロファイル設定

      Clio はOAuth ベースの認証を使用します。

      まず、Clio でOAuth アプリケーションを登録します。Developer アカウントにログインし、Add ボタンをクリックして登録できます。ここでアプリケーションの詳細とスコープを入力します。これらの詳細は、Clio ユーザーがアプリケーションの認可を求められたときに表示されます。OAuth アプリケーションにはclient id(キー)とclient secret(シークレット)が割り当てられます。また、ProfileSettings 接続プロパティでRegion を設定します。

      以下の接続プロパティを設定すると、接続できるようになります。

      • AuthScheme:OAuth に設定します。
      • InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
      • OAuthClientId:アプリ設定で指定されたclient_id に設定します。
      • OAuthClientSecret:アプリ設定で指定されたclient_secret に設定します。
      • CallbackURL:アプリ設定で指定されたRedirect URI に設定します。
      • Region:ProfileSettings でClio の地理的リージョンに設定します。デフォルトはapp.clio.com です。

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

      JDBC URL の構築には、Clio JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。

      java -jar cdata.jdbc.api.jar
      

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

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

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

      jdbc:api:Profile=C:\profiles\Clio.apip;ProfileSettings='Region=your_region';Authscheme=OAuth;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 Clio)を展開()し、Queries を右クリックして Add Query を選択します。
  7. Add Table/View/Query ダイアログで、JDBC URL と Tables を展開()し、クエリで使用するテーブルを選択して OK をクリックします。
  8. Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。
    SELECT Id, Total FROM Bills WHERE State = 'awaiting_payment'
    

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

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

Clio ののデータをレポートに追加

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

  1. File メニューから New、Page Report と進んで新しいレポートを作成するか、既存のレポートの Chart Wizard を開きます。
  2. Query を選択します(または新規作成します。上記を参照)。
  3. クエリのカラムからチャートの Category と Value を設定し、Finish をクリックします。
  4. レポートの View タブをクリックして、チャートを表示します。

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

API Driver で Clio のライブデータに接続

Clio に接続 お問い合わせ