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

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

始める前に

ヒント: Rational® Publishing Engine のインストールには、一連のサンプル・レポートが組み込まれています。文書の発行を開始する前に、この文書生成シナリオの例を検討できます。『REST サンプル・テンプレートの作成』を参照してください。
Rational Quality Manager REST サービス、および Rational Publishing Engine を使用して Rational Quality Manager からデータを抽出するために必要なさまざまな URL に習熟します。Rational Quality Manager REST API のドキュメンテーションを参照してください。

このタスクについて

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

手順

  1. テンプレート開発プロセスの概要を確認するには、『文書テンプレートの設計』を参照してください。 文書の構造と、含めるデータについての計画を開始します。 例えば、最終的な文書を 1 テンプレートから生成するか、またはそれぞれに再使用可能なコンテンツ部分が含まれている複数のテンプレート・ファイルから生成するかどうかを決めます。
  2. Document Studio アプリケーションで、文書テンプレートを作成します
  3. データ・ソースからのデータ・ソース・スキーマを識別します。
    • Rational Quality Manager プロジェクトのコレクションから特定のデータ部分 (テスト・ケース詳細やテスト・スクリプトなど) を追加したり、既知の URL を使用して単一リソースにアクセスしたりするには、feed 引数を使用する URL を構成します。 常にこのスキーマを使用して、Rational Quality Manager プロジェクトからテンプレート内の特定のデータ用にスキーマを動的に構成します。
      • 例: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd
    • Rational Quality Manager プロジェクトの個々のリソースから特定のデータ部分 (テスト・ケース詳細やテスト・スクリプトなど) を追加したり、既知の URL を使用して単一リソースにアクセスしたりするには、qm 引数を使用する URL を構成します。
      • 例: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/qm.xsd
    • REST v2 API を使用して文書を生成する場合、ルート・エントリーへの URL ではなく、データ・ソース・スキーマの URL をサービス・プロバイダーに提供する必要があります。例:
      • 誤: https://server:port/qm/oslc_qm/catalog
      • 正: https://server:port/qm/oslc_qm/catalog/repository/db/schema_repository/
  4. データ・ソース・スキーマを文書テンプレートに追加します。 Rational Quality Manager の場合、以下のステップを実行できます。
    1. Document Studio で、「データ」 > 「データ・ソース・スキーマの追加」をクリックします。
    2. 「スキーマ・タイプ」で、リストからスキーマのタイプを選択します。 Rational Quality Manager の場合、「汎用 XML」を選択します。
    3. 「スキーマ・ファイル」フィールドで、データ・ソース・スキーマとして識別した URL に貼り付けます。
    4. ?abbreviate=false を URL の末尾に付加します。
      • 例: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE Banking (Quality Management)/testcase?abbreviate=false
    5. 「データ・ソース ID」フィールドで、テンプレート内のデータ・ソースの名前を入力します。 「次へ」をクリックします。
    6. リソースがセキュア・サーバーにある場合、「ユーザー名」を指定します。
    7. リソースがセキュア・サーバーにある場合、「パスワード」を指定します。
    8. リストから「認証タイプ」を選択します。 Rational Quality Manager の場合、認証タイプは OAuth です。 OAuth を選択しない場合、各認証タイプは正しいタイプが検出されるまでテストされますが、これによって文書生成時間が増える可能性があります。
  5. エレメントをテンプレートに追加します。 Rational Publishing Engine には、文書の構成に使用できる一連の包括的なテンプレート・エレメントが備わっています。テンプレート・コンテンツ・エディターに要素をドラッグできます。例えば、複数の段落を保持するコンテナー・エレメントを追加できます。 各段落は、それを特定のデータのみと関連付けるテスト条件によって制御できます。 詳しくは、『「パレット」ビューのテンプレート・エレメント』および『テンプレートへのエレメントの追加』を参照してください。
  6. 照会属性、および変数を使用して、テンプレートにデータを追加します。これらの項目は、レポートに生成される情報の内容を指定します。
  7. 出力での表示方法を制御するフォーマット設定とスタイル設定をエレメントに追加します。
  8. レポートにプルするデータを絞り込むフィルターを作成します。 一般的なデータ・ソース URI の詳細バージョンであるフィルターを使用してデータの特定サブセットを指すことで、レポート生成時に Rational Publishing Engine がデータ・ソースから必要以上の情報を取得しないようにすることができます。これらのフィルターには、テンプレートで参照される必要なデータをすべて取得するために十分な条件が設定されている必要があります。そうでない場合、不完全なデータが含まれるレポートが生成されます。 詳しくは、『Rational Quality ManagerReportable REST API』を参照してください。
  9. レポート内でデータを編成するソートを作成します。

フィードバック