Rational Rhapsody ReporterPLUS の標準テンプレート

IBM® Rational® Rhapsody® ReporterPLUS には、多数の標準テンプレートが用意されています。これらのテンプレートは、そのまま使用することも、必要に応じて変更することもできます。以下の表には、これらすべての定義済みテンプレートとそれぞれの説明および推奨される出力フォーマットがリストされています。 リッチ・テキスト・フォーマット (.rtf) とプレーン・テキスト (.txt)・フォーマットは、出力フォーマットの設計機能が単純であり、どのテンプレートにも使用できるため、以下のテーブルにはリストされていません。 ただし、HTML、Microsoft Word および PowerPoint ではさらにフォーマット機能が提供されるため、一部の汎用テンプレートでは推奨されるフォーマットよりも他のフォーマットの方が見やすくなります。

表 1. ReporterPLUS のテンプレート
テンプレート名 推奨される出力フォーマット 説明
class.tpl HTML または Word このテンプレートでは、プロジェクトのクラスに関する情報が定義されます。次のクラス要素の文書を印刷します。
  • 属性
  • 操作
  • 関係
  • イベント
  • ステートチャートとアクティビティー図 (ダイアグラムを含む)
ClassHierarchyBrowser.tpl HTML このテンプレートでは、モデルのクラス階層とその説明およびハイパーリンク索引のリストが生成されます。
ClassHierarchyBrowser2.tpl HTML このテンプレートでは、モデルのルート・クラスとそのタイトル・ページおよびハイパーリンク索引が生成されます。
ClassHierarchyBrowser3.tpl HTML このテンプレートでは、モデルのクラス階層が生成され、これには Java スクリプト、タイトル・ページ、およびハイパーリンク索引が組み込まれています。
ClassOverviewPresentation.tpl PowerPoint このテンプレートでは、パッケージ内のクラス概要がプレゼンテーションとして表示されます。
ClassReport.tpl Word このテンプレートでは、モデル内にあるすべてのクラスの属性と操作情報が取り出されます。
DetailedClassReport.tpl Word このテンプレートでは目次が作成され、すべてのクラスとその属性および操作がリストされます。
DiagramOrientedReport.tpl Word このテンプレートでは、オブジェクト・モデル図 を含むすべてのパッケージが表示されます。パッケージごとに、すべてのオブジェクト・モデル図が表示され、各ダイアグラムの後にそのダイアグラムに含まれる要素が示されます。
DiagramReport_Hierarchy.tpl Word このテンプレートでは、プロジェクトのダイアグラムに関する情報が定義されます。これには、以下のプロジェクト・レベルのダイアグラムとパッケージ・レベルのダイアグラムの両方が含まれます。

1. コラボレーション図

2. コンポーネント図

3. 配置図

4. オブジェクト・モデル図

5. シーケンス図

6. ユースケース図

7. ステートチャートとアクティビティー図

Diagrams.tpl Word および PowerPoint タイトルとモデル内のすべてのダイアグラムが表示されます。
EgalitarianPackageReport.tpl Word このテンプレートでは、ダイアグラム指向のレポートが生成されます。レポートに表示されるダイアグラムは、オブジェクト・モデル図、ユースケース図、シーケンス図、配置図、コラボレーション図、およびコンポーネント図です。
EgalitarianPackageReport2.tpl Word このテンプレートでは、プロジェクト内にあるクラスのダイアグラム指向のレポートが生成されます。レポートに表示されるダイアグラムは、オブジェクト・モデル図、ユースケース図、シーケンス図、配置図、コラボレーション図、およびコンポーネント図です。
FullDetailedProjectReport.tpl Word、PowerPoint、または HTML この汎用テンプレートでは、完全なプロジェクトに関する情報が定義されます。これには、プロジェクトのすべてのモデル要素およびプロジェクトのすべてのダイアグラムが含まれます。
GetStarted.tpl Word および PowerPoint モデル内のすべてのダイアグラムとクラスが表示されます。
HierarchicalPackageReport.tpl Word パッケージを再帰的に下降して、それらのダイアグラム、クラス、およびネストされたパッケージを表示します。
IndexedClassReport.tpl Word パッケージ内のオブジェクト・モデル図とクラスが印刷されます。
MetamodelReport.tpl Word オブジェクト・モデル図を含むすべてのパッケージが表示されます。パッケージごとに、パッケージ内のすべてのオブジェクト・モデル図とクラスが表示されます。このテンプレートでは、クラスごとの属性、操作、および関連が取り出されます。
ModelMetrics.tpl Word または HTML このテンプレートでは、モデル全体とモデル内の各パッケージのメトリックが印刷されます。
OverriddenProperties.tpl Word このテンプレートでは、オーバーライドされたプロパティーに関する情報が定義されます。これには、モデルのすべてのメタクラスのオーバーライドされたプロパティーが含まれます。メタクラス名と、それに続くメタクラスごとのオーバーライドされたプロパティーのテーブルが印刷されます。オーバーライドされたプロパティーがないメタクラスを除外する Q 式が含まれます。
PackageReport.tpl Word このテンプレートでは、以下のパッケージとこれらのパッケージのすべての要素に関する情報が定義されます。
  • すべてのパッケージ (ネスト構造)
  • 各パッケージのすべてのダイアグラム
  • パッケージに含まれる要素
  • サブパッケージとそれらの要素

プロジェクト・レベルの情報は含まれません。

PackageReportFiles.tpl Word このテンプレートでは、以下のパッケージとこれらのパッケージのすべての要素に関する情報が定義されます。
  • すべてのパッケージ (ネスト構造)
  • 各パッケージのすべてのダイアグラム
  • パッケージに含まれる要素
  • サブパッケージとそれらの要素

プロジェクト・レベルの情報は含まれません。

ProjectReport.tpl Word この汎用テンプレートでは、完全なプロジェクトに関する情報が定義されます。これには、プロジェクト内のすべてのモデル要素およびすべてのダイアグラムが含まれます。タイトル・ページと目次も含まれます。
RequirementsTable.tpl Word このテンプレートでは、要件、ユースケース、アクター、およびすべてのダイアグラムがリストされます。
IBM Rational RhapsodyHTML Exporter.tpl HTML のみ このテンプレートでは、プロジェクトの包括的な HTML レポートが生成されます。 また、このテンプレートでは、ラベル別のモデル要素を含む完全なプロジェクトに関する情報が定義されます。
SequenceDiagramWithClasses.tpl Word および PowerPoint このテンプレートでは、シーケンス図とシーケンス図に関係するクラスについての情報が提供されます。タイトル・ ページと目次も含まれます。
Statechart.tpl Word このテンプレートでは、プロジェクトのステートチャートに関する情報が提供されます。ステートチャート、状態、および各ステートチャートに含まれる要素のリストが含まれます。
SysMLDataFlowInPackage.tpl HTML または Word この特殊なテンプレートでは、System Architect (SA) から Rational Rhapsody パッケージにインポートされたデータがリストされます。
SysMLreport.tpl Word または HTML このテンプレートでは SysML プロファイルを使用して、文書生成の基礎となるステレオタイプを提供します。作成時に、SysML がプロジェクト・タイプとして選択されていない場合は、このテンプレートのフィーチャーを十分に活用することはできません。

文書を構成する、主なセクションの順序は以下のとおりです (存在する場合)。

  • 要件図
  • ユースケース図
  • シーケンス図
  • 構造図
  • オブジェクト・モデル図
  • 外部ブロック図
  • 内部ブロック図
  • パラメトリック図
  • 要素辞書
  • モデル構成

作成された文書は必要に応じてハイパーリンクされます。

TabularViews.tpl 任意の選択フォーマット このテンプレートでは、モデル内のすべてのダイアグラムが表示されます。
UseCaseDiagramsDetailedReport.tpl Word このテンプレートでは、プロジェクトのユースケース図、ユースケース、およびアクターに関する情報が提供されます。すべてのユースケース図がリストされ、その後に各ユースケース図に関連するアクターおよびユースケースが示されます。
UseCaseReport.tpl Word このテンプレートでは、モデル内のすべてのユース・ケースとユースケース図が印刷されます。

フィードバック