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

Jerod Johnson
Senior Technology Evangelist

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

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

Bitbucket ののデータに接続

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

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

File メニューから New、Data Source と進み、新しいデータソースを作成します。
表示されるダイアログでデータソース名を入力し（例：CData JDBC Driver for Bitbucket）、JDBC を選択して OK をクリックします。
Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
- Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
```
cdata.jdbc.bitbucket.BitbucketDriver
```
- URL: JDBC URL を入力します。URL は jdbc:bitbucket: から始まり、その後に接続プロパティをセミコロン区切りで記述します。
  ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、Workspacesテーブルです。このテーブルはこのプロパティの設定を必要とせず、クエリを実行すると、Workspaceの設定に使用できるワークスペーススラッグのリストが提供されます。このテーブルにクエリを実行するには、スキーマを'Information'に設定し、SELECT * FROM Workspacesクエリを実行する必要があります。
  
  Schemaを'Information'に設定すると、一般的な情報が表示されます。Bitbucketに接続するには、以下のパラメータを設定してください。
  - Schema: ワークスペースのユーザー、リポジトリ、プロジェクトなどの一般的な情報を表示するには、これを'Information'に設定します。それ以外の場合は、クエリを実行するリポジトリまたはプロジェクトのスキーマに設定します。利用可能なスキーマの完全なセットを取得するには、sys_schemasテーブルにクエリを実行してください。
  - Workspace: Workspacesテーブルにクエリを実行する場合を除き、必須です。Workspacesテーブルへのクエリにはこのプロパティは必要ありません。そのクエリはWorkspaceの設定に使用できるワークスペーススラッグのリストのみを返すためです。
  Bitbucketでの認証
  
  BitbucketはOAuth認証のみをサポートしています。すべてのOAuthフローからこの認証を有効にするには、カスタムOAuthアプリケーションを作成し、AuthSchemeをOAuthに設定する必要があります。
  
  特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを必ず確認してください。
  
  カスタムOAuthアプリケーションの作成
  
  Bitbucketアカウントから、以下のステップを実行します。
  1. 設定（歯車アイコン）に移動し、ワークスペース設定を選択します。
  2. アプリと機能セクションで、OAuthコンシューマーを選択します。
  3. コンシューマーを追加をクリックします。
  4. カスタムアプリケーションの名前と説明を入力します。
  5. コールバックURLを設定します。
    - デスクトップアプリケーションとヘッドレスマシンの場合、http://localhost:33333または任意のポート番号を使用します。ここで設定するURIがCallbackURLプロパティになります。
    - Webアプリケーションの場合、信頼できるリダイレクトURLにコールバックURLを設定します。このURLは、ユーザーがアプリケーションにアクセスが許可されたことを確認するトークンを持って戻るWebの場所です。
  6. クライアント認証情報を使用して認証する予定の場合、これはプライベートコンシューマーですを選択する必要があります。ドライバーでは、AuthSchemeをclientに設定する必要があります。
  7. OAuthアプリケーションに与える権限を選択します。これにより、読み取りおよび書き込みできるデータが決まります。
  8. 新しいカスタムアプリケーションを保存するには、保存をクリックします。
  9. アプリケーションが保存された後、それを選択して設定を表示できます。アプリケーションのKeyとSecretが表示されます。これらを将来の使用のために記録してください。Keyを使用してOAuthClientIdを設定し、Secretを使用してOAuthClientSecretを設定します。
  組み込みの接続文字列デザイナー
  
  JDBC URL の構築には、Bitbucket JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。
```
java -jar cdata.jdbc.bitbucket.jar
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  JDBC URL を設定する際には、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限され、レポートやビジュアライゼーションのデザイン時のパフォーマンス向上に役立ちます。
  
  一般的な JDBC URL は次のとおりです。
```
jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information
```
- User: 認証に使用するユーザー名です。通常は空白のままにします。
- Password: 認証に使用するパスワードです。通常は空白のままにします。
Add Table ダイアログで、レポートに含めるテーブル（または、このデータソースを使用する今後のレポート用のテーブル）を選択し、Add をクリックします。

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

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