Rational® Quality Manager を Rational Publishing Engine 内でデータ・ソースとして定義できます。データは、Rational Quality Manager REST API を使用して抽出されます。このインターフェースはアプリケーションによってインストールおよび実装され、Rational Publishing Engine から独立して動作します。
ヒント: Rational Publishing Engine には、一連のサンプル・レポートが付属しています。文書の発行を開始する前に、この文書生成シナリオの例を検討できます。『
REST サンプル・テンプレートの作成』を参照してください。
始める前に
- Rational Quality Manager REST サービス、および Rational Publishing Engine を使用して Rational Quality Manager からデータを抽出するために必要なさまざまな URL に習熟します。Rational Quality Manager REST API のドキュメンテーションを参照してください。
- データ・ソース・スキーマに接続します。『データ・ソース・スキーマの追加』を参照してください。
- スキーマはローカル・ファイル・システムに配置できます。例えば、https://サーバー:ポート/jazz/service/com.ibm.rqm.integration.service.IntegrationService/schema/feed.xsd は、feed 引数を使用するスキーマ・ファイルです。このスキーマを使用して、Rational Quality Manager プロジェクトからテスト・ケース詳細やテスト・スクリプトなど特定のデータを追加したり、既知の URL で単一のリソースにアクセスしたりできます。
- REST v2 API を使用して文書を生成する場合、ルート・エントリーへの URL ではなく、データ・ソース・スキーマの URL をサービス・プロバイダーに提供する必要があります。 例:
- 誤: https://server:port/qm/oslc_qm/catalog
- 正: https://server:port/qm/oslc_qm/catalog/repository/db/schema_repository/
データ・ソース・スキーマ内の要素を使用して、照会をテンプレートに追加できます。これらの照会は、レポートに生成される情報の内容を指定します。Rational Quality Manager フィード・データ・ソースからの戻りの完全なリストを確実に受け取るようにするには、スキーマ・タイプを汎用 XML として設定し、?abbreviate=false を URI の末尾に追加する必要があります。
例: https://rqmserver:9443/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE
Banking (Quality Management)/testcase?abbreviate=false
- データ・ソース・スキーマに接続したら、テンプレート設計を作成またはインポートできます。Rational Publishing Engine Document Studio を使用して、レポート・テンプレート設計を作成できます。この設計によってレポートのレイアウトが決まります。 『Document Studio を使用したテンプレートのオーサリング』を参照してください。
- 文書の構成を計画して、データを抽出するためのコンテンツを定義します。テンプレート開発プロセスの概要を確認するには、『文書テンプレートの設計』を参照してください。文書が大容量の場合は、文書ブロックごとに別個のテンプレートを作成できます。
- Rational Publishing Engine には、文書の構成に使用できる一連の包括的なテンプレート要素が備わっています。テンプレート・コンテンツ・エディターに要素をドラッグできます。詳しくは、『「パレット」ビューのテンプレート・エレメント』を参照してください。
- 照会、属性、および変数を使用して、テンプレートにデータを追加します。
- データ・ソース構成要素を使用して、実行時には不明な一部のプロパティーを定義できます。『データ・ソース構成エレメントの追加』を参照してください。例えば、qm データ・スキーマは、feed データ・スキーマに基づいて動的に設定されます。常にこのスキーマを使用して、Rational Quality Manager プロジェクトからテンプレート内の特定のデータ用にスキーマを動的に構成します。
- 一般的なデータ・ソース URI をより具体的にしたバージョンであるフィルターを使用してデータのサブセットを指すことで、レポート生成時に Rational Publishing Engine が Rational Quality Manager リポジトリーから必要以上の情報を取得しないようにすることができます。これらのフィルターには、テンプレートで参照される必要なデータをすべて取得するために十分な条件が設定されている必要があります。そうでない場合、不完全なデータが含まれるレポートが生成されます。『Rational Publishing Engine フィルターを使用したデータの抽出』を参照してください。
- レポート・テンプレートを作成し、Rational Quality Manager データ・ポイントをレポート・テンプレートに取り込むと、さまざまな形式のレポートを作成できるようになります。レポートを生成する際には、そのレポートの実行対象の情報が含まれるデータ・ソースに接続しなければなりません。 関連するデータが含まれている Rational Quality Manager リポジトリーを指す URI を指定します。関連するデータを指すには、『データ・ソースへの接続』を参照してください。
注: IBM Rational Quality Manager OSLC
API の場合、文書仕様に許容ヘッダーが指定されていないと、
デフォルトで、Rational Quality Manager は、
リソースを HTML 表現で返します。XML データを取得するには、許容ヘッダーを application/xml に設定する必要があります。
- データ・ソース・スキーマがテンプレートに追加される前に文書仕様にテンプレートが割り当てられていた場合、その文書仕様は非同期状態になります。文書仕様を手動で同期するか、または文書仕様を現在のテンプレートと自動的に同期する設定オプションを選択できます。「文書仕様を現行のテンプレートと同期しますか?」設定の設定方法について詳しくは、『文書設計の設定』を参照してください。
- 文書を発行する前に、選択できる出力オプション、およびテンプレートで使用する要素に最適なオプションについて、『出力プロパティーの指定』のトピックを参照してください。
- これで、文書を発行する準備ができました。『文書の生成』を参照してください。