JReport Designer でBacklog のデータを連携

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

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

Backlog のデータに接続

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

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

2. ［File］［New］［Data Source］と進み、新しいデータソースを作成します。
3. 表示されるダイアログで、データソースの名前(CData JDBC Driver for Backlog) を作成し、JDBC を選択して［OK］をクリックします。
4. ［JDBC Connection Information］ダイアログで、JDBC ドライバーへの接続を構成します。
   • Driver:［Driver］ボックスにチェックがついていることを確認し、ドライバーのクラスの名前を入力します。 cdata.jdbc.backlog.BacklogDriver
   • URL:jdbc:backlog: から始まり、その後にセミコロンで区切られた接続プロパティのリストが続くJDBC URL を入力します。

     Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

     API キー認証

     ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

     1. Backlog の個人設定ページを開きます。
     2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
     3. ApiKey にAPI キーを指定します。
     4. URL はBacklog のテナントURL から取得できます。

     OAuth 認証

     ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。

     ビルトイン接続文字列デザイナー

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

     java -jar cdata.jdbc.backlog.jar

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

     JDBC URL を構成する際、Max Rows 接続プロパティを設定することもできます。これによって戻される行数を制限するため、可視化・レポートのデザイン設計時のパフォーマンスを向上させるのに役立ちます。

     以下は一般的なJDBC URLです。

     jdbc:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;
   • User:認証に使用するユーザー名は、通常空白のままにします。
   • Password:User と同様に認証に使用するパスワードも、通常は空白のままにします。

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

   ダイアログがテーブルのロードを完了したら、［Done］をクリックします。

6. ［Catalog Browser］では、レポートの作成に使用するクエリを作成できます。今すぐ、またはレポートの作成後に作成できますが、どちらにしても、 データソース(CData JDBC Driver for Backlog) を展開()し、［Queries］を右クリックして［Add Query］を選択します。
7. ［Add Table/View/Query］ダイアログで、JDBC URL とTables を展開() し、クエリで使用するテーブルを選択して［OK］をクリックします。
8. ［Query Editor］ダイアログで、含めるカラムを選択するか、［SQL］ボタンをクリックして以下のようにカスタムクエリを手動で入力できます。

   SELECT Id, ProjectID FROM Issues
   

   クエリが作成されたら、［OK］をクリックして［Query Editor］ダイアログを閉じます。この時点で、Backlog を新規または既存のレポートに追加する準備が整いました。

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

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

Backlog を使用してレポートを作成することができるようになりました。

1. 新しいレポートを作成(［File］［New］［Page Report］) するか、既存のレポートの［Chart Wizard］を開きます。
2. クエリを選択(または上記を参照して新しいクエリを作成) します。
3. クエリのカラムからグラフの［Category］と［Value］を割り当て、［Finish］をクリックします。
4. レポートの［View］タブをクリックし、チャートを表示します。