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

JReport Designer でJira Service Management に連携するチャートとレポートを作成します。

加藤龍彦
デジタルマーケティング
最終更新日：2022-10-10

この記事で実現できるJira Service Management 連携のシナリオ

CData

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

CData JDBC Driver for JiraServiceDesk を使用すると、Jira Service Management がリレーショナルデータベースであるかのようにダッシュボードやレポートからリアルタイムデータにアクセスでき、使い慣れたSQL クエリを使用してJira Service Management] をクエリできます。ここでは、JDBC データソースとしてJira Service Management に連携し、JReport Designer で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 JiraServiceDesk 2016\lib\cdata.jdbc.jiraservicedesk.jar;
...

［File］［New］［Data Source］と進み、新しいデータソースを作成します。
表示されるダイアログで、データソースの名前(CData JDBC Driver for JiraServiceDesk) を作成し、JDBC を選択して［OK］をクリックします。
［JDBC Connection Information］ダイアログで、JDBC ドライバーへの接続を構成します。
- Driver:［Driver］ボックスにチェックがついていることを確認し、ドライバーのクラスの名前を入力します。 cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
- URL:jdbc:jiraservicedesk: から始まり、その後にセミコロンで区切られた接続プロパティのリストが続くJDBC URL を入力します。
  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;InitiateOAuth=GETANDREFRESH
- User:認証に使用するユーザー名は、通常空白のままにします。
- Password:User と同様に認証に使用するパスワードも、通常は空白のままにします。
［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 のチュートリアルを参照してください。