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

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

始める前に

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

このタスクについて

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

手順

  1. テンプレート開発プロセスの概要を確認するには、『文書テンプレートの設計』を参照してください。 文書の構造と、含めるデータについての計画を開始します。 例えば、最終的な文書を 1 テンプレートから生成するか、またはそれぞれに再使用可能なコンテンツ部分が含まれている複数のテンプレート・ファイルから生成するかどうかを決めます。
  2. Document Studio アプリケーションで、文書テンプレートを作成します
  3. データ・ソース・スキーマを文書テンプレートに追加します。 Rational Rhapsody の場合、以下のステップを実行できます。
    1. Document Studio で、「データ」 > 「データ・ソース・スキーマの追加」をクリックします。
    2. 「定義済み」フィールドで「Rhapsody」を選択します。
    3. 「タイプ」においてリストからスキーマのタイプを選択します。 Rational Rhapsody の場合、REST を選択します。
    4. 必要に応じて「スキーマ」フィールドを編集するか、 または「参照」をクリックしてスキーマ・ファイルのパスを選択します。 Rational Rhapsody の基本 URL は、https://server:port/Rational/Rhapsody/ です。 ?metadata=schema を付加すると、URL は https://server:port/Rational/Rhapsody/?metadata=schema となります。

      Rational Rhapsody のスキーマのデフォルト・ロケーションは、Rational_Rhapsody_HOME¥RPE¥Schemas です。 例: Rational_Rhapsody_HOME¥RPE¥Schemas¥default.xsd

      プロファイルが適用されていて、新しい条件が含まれるモデルからスキーマを選択する場合、プロファイルおよび新しい条件が含まれるモデルが Rational Rhapsody にロードされていることを確認してください。

    5. リソースがセキュア・サーバーにある場合、「ユーザー名」を指定します。
    6. リソースがセキュア・サーバーにある場合、「パスワード」を指定します。
    7. リストから「認証タイプ」を選択します。 タイプを選択しない場合、各タイプは正しいタイプが検出されるまでテストされますが、これによって文書生成時間が増える可能性があります。
    8. 「終了」をクリックします。 選択したデータ・ソース・スキーマは「データ・ソース・スキーマ」ビューに表示されます。
  4. エレメントをテンプレートに追加します。 Rational Publishing Engine には、文書の構成に使用できる一連の包括的なテンプレート・エレメントが備わっています。テンプレート・コンテンツ・エディターに要素をドラッグできます。例えば、複数の段落を保持するコンテナー・エレメントを追加できます。 各段落は、それを特定のデータのみと関連付けるテスト条件によって制御できます。 詳しくは、『「パレット」ビューのテンプレート・エレメント』および『テンプレートへのエレメントの追加』を参照してください。
  5. 照会属性、および変数を使用して、テンプレートにデータを追加します。これらの項目は、レポートに生成される情報の内容を指定します。
  6. 出力での表示方法を制御するフォーマット設定とスタイル設定をエレメントに追加します。
  7. レポートにプルするデータを絞り込むフィルターを作成します。 一般的なデータ・ソース URI の詳細バージョンであるフィルターを使用してデータの特定サブセットを指すことで、レポート生成時に Rational Publishing Engine がデータ・ソースから必要以上の情報を取得しないようにすることができます。これらのフィルターには、テンプレートで参照される必要なデータをすべて取得するために十分な条件が設定されている必要があります。そうでない場合、不完全なデータが含まれるレポートが生成されます。 Rational Rhapsody は、ネイティブ・フィルターで使用するレポート可能 REST v1 データ・ソースをサポートします。 レポート可能 REST v1 ネイティブ・フィルターでは、テキストを大括弧 [] で囲んで入力するだけで済みます。残りのフィルターは、Rational Publishing Engine によって生成されます。 詳しくは、『Reportable Rest v1』を参照してください。 詳しくは、『REST ネイティブ・フィルターでサポートされるフィルター条件』も参照してください。
  8. キャスト照会フィルターを使用して、照会結果を絞り込むことができます。型キャスト機能は、データ・ソース用の代替フィルターとして機能します。詳しくは、『型キャスト』を参照してください。
  9. レポート内でデータを編成するソートを作成します。

フィードバック