IBM Rational Team Concert をデータ・ソースとして使用したテンプレートの設計

レポートの設計担当者は、Document Studio を使用して、データ・ソース・スキーマをインポートし、レポート・テンプレートを作成することができます。

始める前に

ヒント: Rational® Publishing Engine のインストールには、一連のサンプル・レポートが組み込まれています。文書の発行を開始する前に、この文書生成シナリオの例を検討できます。『REST サンプル・テンプレートの作成』を参照してください。
Rational Team Concert REST サービス、および Rational Publishing Engine を使用する際に Rational Team Concert からデータを抽出するために必要なさまざまな URL に習熟します。『Reportable REST API Wiki: Rational Team Concert で提供されているリソース (Reportable REST API Wiki: Resources provided by Rational Team Concert)』を参照してください。
Rational Team ConcertReportable REST API は、多くの従来型のドメイン API とは異なります。特定の項目 (単一の作業項目やビルド結果など) を指すリソース URL を提供するのではなく、以下の集積リソースへのアクセスを提供します。 それぞれの集積リソースはコンテナー・リソースであり、1 つ以上のエレメントの照会の結果を表します。
  • foundation: プロジェクト・エリア、チーム・エリア、コントリビューター、反復、リンクなどの共通成果物
  • workitem: 要約、カテゴリー、重大度、優先順位などの作業項目成果物
  • apt: チーム・キャパシティー、リソース・スケジュール、不在などのアジャイル計画成果物
  • generic: 一般成果物
  • build: ビルド結果、ビルド結果コントリビューション、ビルド定義、ビルド・エンジンなどのビルド成果物
  • scm: ストリーム、コンポーネント、ストリーム・サイジング・デルタなどのソース管理成果物
これらのリソースにより、レポート用のデータを収集する際にフィルタリングと照会を柔軟に行うことができます。 例えば、作業項目リソースには、REST API に渡された照会またはフィルターに応じて、作業項目に関連する 1 つ以上のエレメントを含めることができます。

このタスクについて

データは、REST API を使用して抽出されます。 このインターフェースはデータ・ソース・アプリケーションによってインストールおよび実装され、Rational Publishing Engine から独立して動作します。 データ・ソースの REST API について詳しくは、データ・ソースの資料を参照してください。

手順

  1. テンプレート開発プロセスの概要を確認するには、『文書テンプレートの設計』を参照してください。 文書の構造と、含めるデータについての計画を開始します。 例えば、最終的な文書を 1 テンプレートから生成するか、またはそれぞれに再使用可能なコンテンツ部分が含まれている複数のテンプレート・ファイルから生成するかどうかを決めます。
  2. Document Studio アプリケーションで、文書テンプレートを作成します
  3. データ・ソース・スキーマを文書テンプレートに追加します。 Rational Team Concert では、基本 URL をアプリケーションに入力することでデータ・ソース・スキーマをディスカバーできます。
    1. Document Studio で、「データ」 > 「データ・ソース・スキーマの追加」をクリックします。
    2. 「スキーマ・タイプ」で、リストからスキーマのタイプを選択します。 Rational Team Concert の場合、REST を選択します。
    3. 「スキーマ・ファイル」フィールドで、データ・ソース・スキーマとして識別した URL に貼り付けます。
      • https://server:port/ccm/rpt/repository/foundation
      • https://server:port/ccm/rpt/repository/workitem
      • https://server:port/ccm/rpt/repository/apt
      • https://server:port/ccm/rpt/repository/generic
      • https://server:port/ccm/rpt/repository/scm
      • https://server:port/ccm/rpt/repository/build
    4. ?metadata=schema を URL の末尾に付加します。
      • 例: https://server:port/ccm/rpt/repository/workitem?metadata=schema
    5. 「データ・ソース ID」フィールドで、テンプレート内のデータ・ソースの名前を入力します。 「次へ」をクリックします。
    6. リソースがセキュア・サーバーにある場合、「ユーザー名」を指定します。
    7. リソースがセキュア・サーバーにある場合、「パスワード」を指定します。
    8. リストから「認証タイプ」を選択します。 Rational Team Concert の場合、認証タイプは OAuth です。 OAuth を選択しない場合、各認証タイプは正しいタイプが検出されるまでテストされますが、これによって文書生成時間が増える可能性があります。
    9. 「終了」をクリックします。 選択したデータ・ソース・スキーマは「データ・ソース・スキーマ」ビューに表示されます。
  4. エレメントをテンプレートに追加します。 Rational Publishing Engine には、文書の構成に使用できる一連の包括的なテンプレート・エレメントが備わっています。テンプレート・コンテンツ・エディターに要素をドラッグできます。例えば、複数の段落を保持するコンテナー・エレメントを追加できます。 各段落は、それを特定のデータのみと関連付けるテスト条件によって制御できます。 詳しくは、『「パレット」ビューのテンプレート・エレメント』および『テンプレートへのエレメントの追加』を参照してください。
  5. 照会属性、および変数を使用して、テンプレートにデータを追加します。これらの項目は、レポートに生成される情報の内容を指定します。
  6. 出力での表示方法を制御するフォーマット設定とスタイル設定をエレメントに追加します。
  7. レポートにプルするデータを絞り込むフィルターを作成します。 一般的なデータ・ソース URI の詳細バージョンであるフィルターを使用してデータの特定サブセットを指すことで、レポート生成時に Rational Publishing Engine がデータ・ソースから必要以上の情報を取得しないようにすることができます。これらのフィルターには、テンプレートで参照される必要なデータをすべて取得するために十分な条件が設定されている必要があります。そうでない場合、不完全なデータが含まれるレポートが生成されます。 Rational Team Concert は、ネイティブ・フィルターで使用するレポート可能 REST v1 データ・ソースをサポートします。 詳しくは、『Jazz.net 上の Reportable REST API (Reportable REST API on Jazz.net)』を参照してください。 例:
    projectArea/name="Rational Publishing Engine"  and target/name="1.2.1"
    解決された要求は、次のようになります。
    fields=workitem/workItem[projectArea/name="Rational Publishing Engine" and target.name="1.2.1"]/(@href|summary)
    注: すべてのフィールドをネイティブ・フィルターに使用できるわけではありません。
  8. レポート内でデータを編成するソートを作成します。

フィードバック