付属ドキュメント

項目

説明

付属ドキュメントの作成

付属ドキュメントエディタを利用して、以下のいずれかが可能です。

• ドキュメント要素に対して内容を定義する
• 任意の要素に付属ドキュメントを追加する

ドキュメント要素を利用する利点として、以下のような項目が挙げられます。

• ドキュメント自体がモデルブラウザ内に要素として表示される
• ドキュメントをドキュメント要素として表現し、そのドキュメント要素と他の要素を関係づけることで、要素とドキュメントの関係を可視化できる。また、1つの要素と複数のドキュメントを関係づけることもできる。
• 同様に、複数の要素と1つのドキュメント要素を関係づけることで、それぞれの要素ごとにドキュメントのコピーを持つことなく、ドキュメントと要素との関係を明示できる。

付属ドキュメントとして活用する方法の利点としては、次のような項目が挙げられます。

• ドキュメントと要素を密接に関連づけ、一体のものとして管理できる
• 一体になっているので、ドキュメントのみが変更・削除などをされることを防ぎやすい

付属ドキュメントのテンプレートの作成

付属ドキュメントの内容をテンプレートとして定義して、新規に付属ドキュメントを作成するときに利用することができます。

作成したテンプレートは、モデルブラウザ内のリソースタブの「付属ドキュメント」フォルダ内に格納され、編集や削除が可能です。

付属ドキュメントの編集

付属ドキュメントの内容は、文字に対して書式を設定したり、画像や表を利用することもできます。

付属ドキュメント内にリンクを配置する

付属ドキュメント内には、モデル内の要素へのリンクを追加することもできます。

リンクをクリックすると、対象の要素のモデルブラウザ内の位置にカーソルが移動しますので、Enterprise Architectの機能で利用されているダイアグラムなどに移動することができます。

同様に、ダイアグラムへのリンクも配置することができます。

付属ドキュメントの内容を
ドキュメントに出力する

付属ドキュメント内容は、ドキュメントの出力時にコンテンツとして出力することができます。

ドキュメントのテンプレートで、付属ドキュメントの内容を出力するように設定する必要があります。

付属ドキュメントを持つ要素を探す

ダイアグラムに配置された要素が付属ドキュメントを持つ場合、ダイアグラムの「付属ドキュメントのアイコンを表示」のプロパティが有効の場合、ドキュメントアイコン(ビルド1626以降)あるいは赤文字のAのマーク(ビルド1625以前)が要素の右下に表示されます。

検索機能を利用し、付属ドキュメントを持つ要素を探すこともできます。SQL検索で検索ルールを定義する場合の定義例は次の通りです。

SELECT ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE,

Name AS Object, Object_Type AS [Type], Stereotype, Author,

Scope, Status, Phase, CreatedDate, ModifiedDate

FROM t_object

WHERE t_object.Style LIKE '#WC#MDoc=1#WC#'

(参考:検索ルールの新規作成、ダイアグラムタブ)

付属ドキュメントを削除する

不要な付属ドキュメントは削除することができます。また、既存の内容を外部のファイルの内容で上書きすることもできます。

付属ドキュメントを削除すると、要素に表示される赤字のAは、非表示になります。

ヒント:

• ドキュメント要素は、自動的に付属ドキュメントを保持し、編集・参照することができます。ドキュメント要素はどのエディションでも利用できます。

• 付属ドキュメントの内容は、APIを利用して操作することができます。GetLinkedDocument (), DeleteLinkedDocument (), SaveLinkedDocument (string Filename) および LoadLinkedDocument (string Filename)が利用できます。