Bitbucket のデータを使ったCrystal Reports を発行

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

CData ADO.NET Provider for Bitbucket は、Crystal Reports for Visual Studio 開発環境に統合されています。標準のADO.NET コンポーネントを使用して、SQL Server と同じようにレポートを作成でき、さらにBitbucket とリアルタイムで連携できます。この記事では、開いたときに更新されるレポートにBitbucket のデータを追加するために必要な3つのステップを完了する方法を説明します。

Note：このチュートリアルを実行するには、Crystal Reports とVisual Studio のデベロッパーバージョンをインストールしてください。

Crystal Reports アプリケーションを作成する

この記事を実行するにはVisual Studio Crystal Reports プロジェクトが必要になります。この記事では、WPF アプリケーションにレポートを追加します。「File」->「New Project」とクリックし、Crystal Reports WPF Application テンプレートを選択することで、作成できます。表示されるウィザードで空のレポートを作成するオプションを選択します。

Bitbucket に接続する

Server Explorer からBitbucket のADO.NET データソースを作成すると、Crystal Reports ウィザードおよびCrystal Reports Designer で使用できるDataSet を簡単に作成できます。Server Explorer で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を設定します。

接続を構成する際に、Max Rows 接続プロパティも設定できます。これにより返される行数が制限されるため、レポートやビジュアライゼーションをデザインするときのパフォーマンスを向上させることができます。

DataSet を作成する

以下のステップに従ってVisual Studio ADO.NET DataSet Designer を使用し、ADO.NET DataSet オブジェクトを作成します。Crystal Reports はBitbucket テーブルのメタデータを含むDataSet オブジェクトにバインドします。またこのアプローチでは、App.config に接続文字列が追加されることに注意してください。後にこの接続文字列を使用してデータをレポートにロードします。

1. Solution Explorer でプロジェクトを右クリックし、「Add」->「New Item」をクリックします。
2. DataSet を選択します。DataSet Designer が表示されます。
3. Server Explorer からDataSet Designer にテーブルをドラッグ & ドロップします。この記事ではIssues テーブルを使用します。

Bitbucket フィールドをレポートに追加する

以下のステップに従って、DataSet からレポートにカラムを追加します。

1. Solution Explorer で.rpt ファイルをダブルクリックし、Crystal Reports Designer を開きます。
2. デザイナーを右クリックし、「Database」->「Database Expert」と進みます。
3. Project Folder とADO.NET DataSets ノードを展開し、作成したDataSet を「Selected Tables」ボックスにドラッグします。これで、Field Explorer からフィールドにアクセスできます。
4. Field Explorer からレポートの「Details」セクションまたは別のセクションにフィールドをドラッグ & ドロップします。

レポートにデータをロードする

メタデータのみを含むDataSet を作成したら、実際のデータを含むDataTable を作成する必要があります。BitbucketDataAdapter を使用して、SQL クエリの結果をDataTable に入力できます。

1. System.Configuration.dll への参照をプロジェクトに追加して、App.config から接続文字列を使用できるようにします。
2. App.config で.NET 4.0 を使用する場合にCrystal Reports との互換性を保つため、次のコードを設定ノードに追加します。

   
     <startup useLegacyV2RuntimeActivationPolicy="true">
       <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
     </startup>
   

3. Window.xaml.cs ファイルに以下の参照を追加します。

   using System.Configuration;
   using CrystalDecisions.CrystalReports.Engine;
   using CrystalDecisions.Shared;
   using System.Data.CData.Bitbucket;
   using System.Data;
   

4. 以下のWindow_Loaded メソッドをWindow.xaml.cs に追加し、DataTable を返すSQL クエリを実行します。最低でも、レポートで使用されているカラムと同じカラムは選択する必要があることに注意してください。

   private void Window_Loaded(object sender, RoutedEventArgs e) {
     ReportDocument report = new ReportDocument();
     report.Load("../../CrystalReport1.rpt");
    var connectionString = ConfigurationManager.ConnectionStrings["MyAppConfigConnectionStringName"].ConnectionString;
     using (BitbucketConnection connection = new BitbucketConnection(connectionString)) {
       BitbucketDataAdapter dataAdapter = new BitbucketDataAdapter(
       "SELECT Title, ContentRaw FROM Issues WHERE Id = '1'", connection);
        DataSet set = new DataSet("_set");
        DataTable table = set.Tables.Add("_table");
        dataAdapter.Fill(table);
        report.SetDataSource(table);
     }
     reportViewer.ViewerCore.ReportSource = report;
   }
   

5. Window.xaml ファイルでLoaded イベントを追加し、Window タグを以下のようにします。

   
   <Window x:Class="CrystalReportWpfApplication4.Window1"
           xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
           xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
           xmlns:cr="clr-namespace:SAPBusinessObjects.WPF.Viewer;assembly=SAPBusinessObjects.WPF.Viewer"
           alt="WPF Crystal Report Viewer" Height="600" Width="800" Loaded="Window_Loaded">
           ...
   </Window>
   

6. レポートを実行します。レポートが読み込まれると、プロバイダはクエリを実行して現在のデータを取得します。

Bitbucket のデータのチャートを作成する

Chart Expert などのエキスパートとともにDataSet を使用することもできます。

1. Crystal Reports Designer を右クリックして「Insert」->「Chart」とクリックします。
2. 「Report Header」または「Report Footer」セクションを選択します。Chart Expert が表示されます。
3. 「Type」タブでチャートタイプを選択します。この記事では、サイドバイサイドの棒グラフを使用します。
4. 「Data」タブでx 軸のカラムと条件を選択します。例えば、DataSet ノードのTitle カラムを「On Change Of」メニューの下のボックスにドラッグします。
5. x 軸のカラムを選択し、「TopN」ボタンと「Order」ボタンをクリックして並べ替えと制限を構成します。
6. y 軸のカラムとサマリー操作を選択します。例えば、DataSet ノードのContentRaw カラムを「Show Values」ボックスにドラッグします。
7. レポートを実行します。

Crystal Reports は、Bitbucket API などに対してGROUP BY を実行する代わりに、DataTable にロード済みのデータに対して集計を実行することに注意してください。これは、レポート作成ウィザードにも当てはまります。

別のDataSet を作成し、他のクエリを入力することで、Bitbucket に対して実行されるクエリをより細かく制御できます。ドライバのSQL エンジンの詳細については、ヘルプドキュメントを参照してください。