JReport Designer で Jira Service Management ののデータを連携利用

Jerod Johnson
Senior Technology Evangelist

JReport Designer で Jira Service Management のデータをもとにチャートとレポートを作成。

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

Jira Service Management ののデータに接続

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

...
set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Jira Service Management 2016\lib\cdata.jdbc.jiraservicedesk.jar;
...

File メニューから New、Data Source と進み、新しいデータソースを作成します。
表示されるダイアログでデータソース名を入力し（例：CData JDBC Driver for Jira Service Management）、JDBC を選択して OK をクリックします。
Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
- Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
```
cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
```
- URL: JDBC URL を入力します。URL は jdbc:jiraservicedesk: から始まり、その後に接続プロパティをセミコロン区切りで記述します。
  Jira Service Management 接続プロパティの取得・設定方法
  
  任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。
  - URL（例：https://yoursitename.atlassian.net）
  カスタムフィールドへのアクセス
  
  デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。
  Jira Service Management への認証
  
  ベーシック認証
  
  ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。
  - AuthScheme：Basic に設定。
  - User：認証ユーザーのユーザー名に設定。
  - Password：認証ユーザーのパスワードに設定。
  API トークン
  
  Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。
  
  データに接続するには以下を設定します。
  - AuthScheme：APIToken に設定。
  - User：認証ユーザーのユーザー名に設定。
  - APIToken：作成したAPI トークンに設定。
  ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。
  
  OAuth 2.0
  Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。
  この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。
  
  組み込みの接続文字列デザイナー
  
  JDBC URL の構築には、Jira Service Management JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。
```
java -jar cdata.jdbc.jiraservicedesk.jar
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  JDBC URL を設定する際には、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限され、レポートやビジュアライゼーションのデザイン時のパフォーマンス向上に役立ちます。
  
  一般的な JDBC URL は次のとおりです。
```
jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;
```
- User: 認証に使用するユーザー名です。通常は空白のままにします。
- Password: 認証に使用するパスワードです。通常は空白のままにします。
Add Table ダイアログで、レポートに含めるテーブル（または、このデータソースを使用する今後のレポート用のテーブル）を選択し、Add をクリックします。

テーブルの読み込みが完了したら Done をクリックします。
Catalog Browser で、レポートを作成するためのクエリを作成できます。これはレポート作成前でも作成後でも行えます。データソース（CData JDBC Driver for Jira Service Management）を展開（）し、Queries を右クリックして Add Query を選択します。
Add Table/View/Query ダイアログで、JDBC URL と Tables を展開（）し、クエリで使用するテーブルを選択して OK をクリックします。
Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。
```
SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'
```
クエリが構築できたら、OK をクリックして Query Editor ダイアログを閉じます。これで Jira Service Management のデータを新規または既存のレポートに追加する準備が整いました。

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