Jaspersoft Studio から Bitbucket のデータに接続

この記事では、CData JDBC Driver for Bitbucket を使って、Jaspersoft Studio からBitbucket に標準JDBC データソースとして接続する方法を説明します。標準のJaspersoft ウィザードを使ってBitbucket へのSQL クエリを作成していきます。クエリは直接Bitbucket API に実行されるため、Bitbucket のデータへのリアルタイム接続が可能になります。

Bitbucket のデータにJDBC データソースとして接続

Jaspersoft Studio でJDBC データソースを作成するには、データアダプタを作成します。

1. Repository Explorer ビューで、Data Adapters ノードを右クリックし、Create Data Adapter をクリックします。
2. Database JDBC Connection を選択します。
3. ドライバーのわかりやすい名前を入力します。
4. Driver Classpath タブで、Add をクリックします。表示されたダイアログで、インストールディレクトリのlib サブフォルダに移動し、ドライバーJAR を選択します。
5. Database Location タブで、JDBC ドライバーのクラス名を入力します：cdata.jdbc.bitbucket.BitbucketDriver
6. JDBC URL を入力します。

   ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、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 接続プロパティも設定できます。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時のパフォーマンス向上に役立ちます。

   以下はBitbucket の一般的なJDBC URL です：

   jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information
   

   

Bitbucket のデータでレポートを作成

以下のステップに従って、Bitbucket へのSQL クエリを作成します。これはシンプルなレポートの基礎となります。

1. File -> New Jasper Report をクリックします。テンプレートを選択し、親プロジェクトを選択して、レポートファイルを指定します。
2. Data Adapter メニューで、前のセクションで作成したデータアダプタを選択します。
3. Diagram タブで、テーブルをボックスにドラッグして、使用したいカラムをクリックします。または、Texts タブでカスタムクエリを入力します。例：

   SELECT Title, ContentRaw FROM Issues WHERE Id = '1'
   

   
4. データセットに含めるフィールドを選択します。この例では、すべてのフィールドを使用します。
5. Group By ステップをスキップして、ウィザードを完了します。

Preview タブで、現在のBitbucket のデータでレポートがどのように表示されるかをプレビューできます。

チャートを作成

以下のセクションでは、独自のSQL クエリに紐づいたチャートを作成する方法を説明します。リモートデータソースからデータを取得する際、特定のレポートオブジェクト用に作成したより制限的なクエリを使用すると、パフォーマンスが向上する場合があります。

DataSet を作成

以下のステップに従って、チャートを入力する新しいデータセットを作成します。

1. レポートの編集エリアで、Design タブをクリックします。
2. Outline ビューで、レポートのルートノードを右クリックし、Create Dataset をクリックします。
3. データセットの名前を入力し、接続またはデータソースから新しいデータセットを作成するオプションをクリックします。
4. Data Adapter メニューで、最初のセクションで作成したデータアダプタを選択します。
5. 次のようなクエリを入力します：

   SELECT Title, ContentRaw FROM Issues WHERE Id = '1'
   

   
6. データセットに含めるフィールドを選択します。この例ではTitle とContentRaw を使用します。
7. フィールドによるグループ化のステップをスキップして、ウィザードを完了します。

チャートを構成

データセットを追加した後、以下のステップに従ってチャートウィザードでカラム値をチャートの軸にマッピングします。

1. Outline ビューでSummary ノードをクリックします。Properties ビューで、高さを400ピクセルに設定します。Summary バンドはレポートの最後に印刷されます。
2. パレットからチャートをSummary にドラッグします。チャートウィザードが表示されます。
3. チャートのタイプを選択します。この例では棒グラフを使用します。
4. Dataset メニューで、チャート用に作成したデータセットを選択します。
5. Dataset タブで、マスターレポートの入力に使用されたものと同じJDBC 接続を使用するオプションを選択します。
6. チャートのシリーズを指定します：Series メニューの横にあるボタンをクリックし、Add をクリックします。表示されたExpression Editor で、Title カラムをダブルクリックして、式を$F{Title} に設定します。

7. y 軸の値を指定します：チャートウィザードで、Value ボックスの横にあるボタンをクリックします。Expression Editor で、ContentRaw をダブルクリックして、式を$F{ContentRaw} に設定します。

8. シリーズ要素のラベルを指定します：チャートウィザードで、Label ボックスの横にあるボタンをクリックします。Expression Editor で、Title カラムをダブルクリックして、式を$F{Title} に設定します。必要に応じて、以下の式のようにカラムの型を文字列に変換します：

   $F{Title}.toString()
   

   
9. チャートを拡大してSummary セクションを埋めます：チャートを右クリックして、Size to Container -> Fit Both をクリックします。

レポートの実行

他のJDBC データソースと同様に、Bitbucket のデータでレポートを生成できるようになりました。Jaspersoft Studio はレポートの実行ごとにデータを定期的に更新します。