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

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

始める前に

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

このタスクについて

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

手順

  1. テンプレート開発プロセスの概要を確認するには、『文書テンプレートの設計』を参照してください。 文書の構造と、含めるデータについての計画を開始します。 例えば、最終的な文書を 1 テンプレートから生成するか、またはそれぞれに再使用可能なコンテンツ部分が含まれている複数のテンプレート・ファイルから生成するかどうかを決めます。
  2. Document Studio アプリケーションで、文書テンプレートを作成します
  3. データ・ソース・スキーマを文書テンプレートに追加します。 Rational ClearQuest では、基本 URL をアプリケーションに入力することでデータ・ソース・スキーマをディスカバーできます。
    1. ご使用のバージョンの Rational ClearQuest に適用されるスキーマ・ディスカバリー・ウィザードを開きます。
      • REST v1 を使用する初期バージョンの Rational ClearQuest の場合、「データ」 > 「スキーマ・ディスカバリー」 > 「REST スキーマ・ディスカバリー」をクリックします。
      • REST v2 を使用する後続バージョンの Rational ClearQuest の場合、「データ」 > 「スキーマ・ディスカバリー」 > 「REST v2 スキーマ・ディスカバリー」をクリックします。
    2. リソースの「基本 URL」を指定します。
      • REST v1 バージョンの Rational ClearQuest の場合、Rational Publishing Engine はスキーマをディスカバーしてデータを照会するため Rational データ・サービスを使用します。 データ・サービスの基本 URL は、https://server:port/DataServices/ClearQuest です。
      • REST v2 バージョンの Rational ClearQuest の場合、ServiceProvider URL から開始しています。 ユーザーは、 Rational ClearQuest REST v2 の ServiceCatalog URL (例: https://サーバー:ポート/context/oslc) にアクセスすることで、ServiceProvider URL を取得できます。HTTP ヘッダー OSLC-Core-Version を 2.0 に設定して、application/rdf+xml にアクセスします。戻された結果から、ServiceProvider URL の rdf:about を見つけることができます。
        REST v2 API を使用して文書を生成する場合、ルート・エントリーへの URL ではなく、データ・ソース・スキーマの URL をサービス・プロバイダーに提供する必要があります。例:
        • 誤: https://server:port/cqweb/oslc
        • 正: https://server:port/cqweb/oslc/repo/repository/db/schema_repository/
    3. リストから「認証タイプ」を選択します。 タイプを選択しない場合、各タイプは正しいタイプが検出されるまでテストされますが、これによって文書生成時間が増える可能性があります。
    4. リソースがセキュア・サーバーにある場合、「ユーザー名」を指定します。
    5. リソースがセキュア・サーバーにある場合、「パスワード」を指定します。
    6. 「次へ」をクリックします。 入力した基本 URL には ?metadata=schema が自動的に付加されます。 例: https://server:port/service/cq/records/defects?metadata=schema
    7. 「終了」をクリックします。 選択したデータ・ソース・スキーマは「データ・ソース・スキーマ」ビューに表示されます。
  4. エレメントをテンプレートに追加します。 Rational Publishing Engine には、文書の構成に使用できる一連の包括的なテンプレート・エレメントが備わっています。テンプレート・コンテンツ・エディターに要素をドラッグできます。例えば、複数の段落を保持するコンテナー・エレメントを追加できます。 各段落は、それを特定のデータのみと関連付けるテスト条件によって制御できます。 詳しくは、『「パレット」ビューのテンプレート・エレメント』および『テンプレートへのエレメントの追加』を参照してください。
  5. 照会属性、および変数を使用して、テンプレートにデータを追加します。これらの項目は、レポートに生成される情報の内容を指定します。
  6. 出力での表示方法を制御するフォーマット設定とスタイル設定をエレメントに追加します。
  7. レポートにプルするデータを絞り込むフィルターを作成します。 一般的なデータ・ソース URI の詳細バージョンであるフィルターを使用してデータの特定サブセットを指すことで、レポート生成時に Rational Publishing Engine がデータ・ソースから必要以上の情報を取得しないようにすることができます。これらのフィルターには、テンプレートで参照される必要なデータをすべて取得するために十分な条件が設定されている必要があります。そうでない場合、不完全なデータが含まれるレポートが生成されます。

    Rational ClearQuest アダプターは、レポート可能 REST v1 データ・ソースのネイティブ・フィルターをサポートします。 レポート可能 REST v1 ネイティブ・フィルターでは、テキストを大括弧 [] で囲んで入力するだけで済みます。残りのフィルターは、Rational Publishing Engine によって生成されます。 詳しくは、『Reportable Rest v1』を参照してください。

    アダプターなしの Rational ClearQuest バージョン 8 は、レポート可能 REST v2 データ・ソースのネイティブ・フィルターをサポートします。詳しくは、『Rational ClearQuestOSLC CM REST API』を参照してください。

    サンプル変数フィルター:
    cq:Product{cq:Product="${productName}") 
    productNameRational Publishing Engine である場合の、サンプルの解決済みフィルター。
    cq:Product{cq:Product="Rational Publishing Engine")
    注:
    • 要求がデータ・ソースに対して行われるのは必要な場合のみです。 例えば、条件を使用して、エレメントにデータが含まれている場合のみ出力に表示するよう指定できます。 コンテナー・エレメントに対する条件が variable == "true" であるとします。 この条件が満たされず、どのデータも変数条件を満たさない場合、要求がデータ・ソースに対して行われることはありません。
    • 要求を行う前にネイティブ・フィルターを計算できます。 ネイティブ・フィルターは、照会が検出された時点で計算され、その時点での変数値を使用します。これでテンプレートでの計算を実行できますが、これによりネイティブ・フィルターは影響を受けます。
  8. レポート内でデータを編成するソートを作成します。

フィードバック