このページを共有
拡張レポートのための OData のサポート
この項では、拡張レポート機能のために OData を操作する方法について説明します。
このトピックの内容:
概要
REST API を使用するための OASIS REST ベースの標準である OData（Open Data Protocol）がサポートされています。OData をサポートするビジネス・インテリジェンス（BI）ツールを使用して、プロジェクト・データに接続し、グラフやレポートを生成できます。これにより、レポートやグラフで提供される機能だけでなく、拡張レポート機能を使用してデータを視覚化し、分析できるようになります。
OData を操作するワークフローは次のとおりです。
-
前提条件で指定されているとおりに、OData の接続を準備します。
-
OData をサポートする BI ツール（Power BI や Tableau など）を使用して、OData を介してプロジェクト・データを取得します。
詳細については、BI ツールからプロジェクト・データへの接続を参照してください。
-
取得したデータの分析前の処理を行います。
-
BI ツールを使用して、プロジェクト・データのレポートとグラフを生成します。
サポートされている OData のバージョン
OData バージョン 4.0 がサポートされています。
OData バージョン 4.0 をサポートするツールは、適切に連携できる可能性が高いです。
注: OData をサポートするツールのリストについては、OData Ecosystem に移動し、［Consumers］を選択してください。
OData のサポートは、Power BI と Excel でテストされています。
サポートされているエンティティ・タイプ
BI ツールからプロジェクトに接続すると、次のプロジェクト・データを取得できます。
-
リリース
-
サイクル
-
要件
-
テスト・フォルダ
-
テスト
-
テスト・デザイン・ステップ
-
テスト・セット・フォルダ
-
テスト・セット
-
テスト・インスタンス
-
テスト実行
-
ユーザ
-
不具合
前提条件
OData を使用する前に、次の接続情報を収集します。
| 前提条件 | 詳細 |
|---|---|
| OData のサポートを有効にする |
OData のサポートを有効にするには、IS_ODATA_SERVICE_ENABLED パラメータを Y に設定します。 詳細については、「ALM サイト・パラメータ」を参照してください。 |
| OData データ・ソース URL |
プロジェクト・データには一意の OData データ・ソース（または OData フィード）を通じてアクセスできるため、ユーザはさまざまな BI ツールを通じてデータにシームレスに接続できます。
|
| サインイン資格情報 |
API キーを使用して、OData データ・ソースに接続します。ユーザ・アカウントに対して次の手順を実行します。
詳細については、API キー管理を参照してください。 |
| 正式名のサポートを有効にする |
ユーザの正式名を取得する場合にのみ必要です。 標準設定では、ユーザのユーザ名のみが取得されます。正式名も取得する場合は、IS_ODATA_SHOW_FULL_NAME サイト・パラメータを Y に設定します。 注：正式名のサポートを有効にする前に、組織のポリシーを検討してください。 |
| プライベート証明書をインストールする |
環境でプライベート証明書が使用されている場合は、BI ツールが実行されているマシンにも証明書がインストールされていることを確認してください。 |
認証
BI ツールから OData データ・ソースに初めて接続するときは、認証が必要です。
BI ツールの基本認証オプションを使用します。
アカウントに関連付けられたクライアント ID と API キー・シークレットを使用して認証します。
| フィールド | 説明 |
|---|---|
| User name |
クライアント ID を入力します。 |
| Password |
API キー・シークレットを入力します。 |
| Select which level to apply these settings to |
BI ツールによって異なります。 認証のためにユーザ名とパスワードを共有できるレベルを指定します。
|
注: クライアント ID または API キー・シークレットが有効でなくなった場合、認証は失敗します。権限を編集またはクリアして、新しい資格情報で認証します。
BI ツールからプロジェクト・データへの接続
Power BI、Tableau、Excel など、OData をサポートする任意のビジネス・インテリジェンス・ツールを使用してプロジェクト・データに接続できます。
-
Power BI を開きます。［Home］＞［Get Data］＞［OData feed］を選択します。
-
［OData feed］ダイアログ・ボックスで、［Basic］を選択し、ALM OData のデータ・ソース URL を入力して、［OK］をクリックします。
-
［Basic］を選択し、サインイン資格情報を入力します。
例：Tableau からプロジェクト・データへの接続
-
Tableau を開きます。サイド・メニュー＞［Connect］＞［To a Server］に移動し、［More］、［OData］の順に選択します。
-
［Server］フィールドに、ALM OData のデータ・ソース URL を入力します。
-
［Authentication］フィールドで、［Username and Password］を選択します。
-
サインイン資格情報を入力します。
例：Excel を使用したプロジェクト・データへの接続
-
Excel ワークシートを開きます。［Data］＞［Get Data ］＞［ From Other Sources］＞［From OData Feed］を選択します。
-
［OData feed］ダイアログ・ボックスで、［Basic］を選択し、ALM OData のデータ・ソース URL を入力して、［OK］をクリックします。
-
［Basic］を選択し、サインイン資格情報を入力します。
取得したデータの分析前の処理
この項では、BI ツールを使用して分析する前のプロジェクト・データの処理について、推奨事項を示します。
データを絞り込んでから使用する場合は、取得したデータをフィルタするために、次のタイプのテーブル・カラムを使用できます。
-
ID：たとえば、不具合 ID などです。
-
時刻：たとえば、実際の修正時間などです。
-
日付：たとえば、終了日などです。
注: フィルタを使用する場合、And 演算子のみがサポートされます。
複数のテーブルを含む OData データ・ソースに接続する場合、テーブル・カラムの展開オプションを使用して、関連テーブルからカラムを追加できます。この方法は、複数のテーブル全体を対象とするクエリの作成に役立ちます。
注: 展開オプションは、エンティティの関係が 1 対 1 の場合にのみ推奨されます。
たとえば、Defects テーブルには、複数の関連テーブルへの参照が含まれ、その中に Releases テーブルがあるとします。Defects テーブルの target_rel 列の展開オプションを使用して、リリースに関連するカラム（たとえば、name カラム）を追加できます。target_rel カラムが展開され、target_rel.name という名前のカラムがもう 1 つ追加され、Defects テーブルに追加されます。
Defects テーブルの detected_by_user カラムを展開する別の例を示します。full_name を選択すると、detected_by_user.full_name カラムが追加されます。
注: ユーザの正式名を追加できるかどうかは、正式名の取得のサポートが有効になっているかどうかによって異なります。詳細については、正式名のサポートを有効にするを参照してください。
テーブル間の関係を作成して、結果を正確に計算し、分析で正しい情報を表示します。関係の作成は、ALM の 1 対多、多対多、または複数レベルのエンティティ関係を扱う場合に特に必要です。
以下の例は、テスト・セット・フォルダ、テスト・セット、テスト・インスタンス、およびテストの関係です。
トラブルシューティング
次の表に、OData の使用時に発生する可能性のある問題を示しています。
| 問題 | 解決策 |
|---|---|
OData：リクエストが失敗しました：基礎となる接続が閉じられました：保護された SSL/TLS チャネルの信頼を確立できませんでした
|
これは、環境でプライベート証明書を使用しているが、BI ツールが実行されているマシンに同じ証明書をインストールしていないことが原因で発生する可能性があります。 |
