前页 后页

链接文件

在模型中开发元素时,可能需要提供有关元素的大量文档,以提供比在“注释”字段中创建的结构化文本更多的结构化文本。在这种情况下,您可以创建链接到该元素的格式化文档。您可以从头开始创建链接的文档,也可以使用通过链接的文档模板编辑器定义的一系列链接的文档模板之一来创建链接的文档。链接文档保存在模型中。

处理链接的文档

任务

详情

也可以看看

创建链接文档

您可以创建链接文档:

  • 在附加到模型元素的Document Artifact元素内,或
  • 直接在模型元素上
使用文档工件托管链接文档的优点包括:
  • 文档工件的可见性以及因此在“浏览器”窗口中链接的文档的可见性
  • 由于您在一个元素中只能有一个链接文档,因此将多个文档中的每一个托管在其自己的文档工件中,并将多个文档工件连接到一个模型元素意味着您提供信息的范围更广
  • 同样,通过将多个元素与一个文档关联到一个文档(通过将其连接到宿主Document Artifact元素)意味着您可以共享信息,而不必复制它
直接在元素上使用链接文档的优点包括:
  • 更紧密地将文档的内容绑定到元素,因此信息所指的含义较少
  • 将文档本身更紧密地绑定到元素,因此在不参考文档所属元素的情况下更改,移动或删除文档的风险较小
创建文档工件 在元素上创建链接文档

创建链接文档模板

您可以将链接文档基于系统提供的一系列模板之一,每个模板都代表一个项目文档类型。

您还可以在“ 链接文档”文件夹中“浏览器”窗口的“资源”选项卡中创建和使用自己的链接文档模板。

创建链接的文档模板

编辑链接的文档

您可以在创建文档的模板和文档本身中定义链接文档的样式,格式和布局。您可以从“文档”窗口和“链接文档编辑器”中的选定元素中编辑“链接文档”。

编辑链接的文档模板 编辑链接的文档

在链接文档中创建超链接

链接文档与特定元素密切相关,但是您也可以在文档中直接创建指向模型中其他元素的超链接。跟随链接,您可以对该元素执行任何常规操作。

同样,您可以创建要链接到的新元素或图。

您还可以创建指向其他形式文档的超链接。

链接文档的超链接 从文档创建元素

在RTF报表中包含链接文档

当您选择文档模板设计器中的“链接文档”复选框时,无论链接文档如何创建,它们都会呈现到文档报告中。

报告链接文件

找到链接的文档

在图中,任何具有链接文档的元素在右下角均标记有“ A”符号。

您还可以通过创建包含以下SQL查询的自定义搜索,使用模型搜索功能来搜索具有链接文档的元素:

选择ea_guid AS CLASSGUID,Object_Type AS CLASSTYPE,名称AS对象,Object_Type AS [类型],构造型,作者,范围,状态,阶段,CreatedDate,ModifiedDate

来自t_object

在t_object.Style类似'#WC#MDoc = 1#WC#'

创建搜索定义

删除链接文件

您可以从元素中完全删除“链接文档”,也可以删除文档的内容并将其替换为外部文件的内容。

替换或删除链接的文档

笔记

  • 您可以创建Document Artifact元素以在所有版本的Enterprise Architect包含链接的文档
  • 在Enterprise Architect所有版本中,您都可以创建文档并将其链接到模型中的任何UML元素。
  • 您可以使用方法GetLinkedDocument(),DeleteLinkedDocument(),SaveLinkedDocument(字符串文件名)和LoadLinkedDocument(字符串文件名),通过自动化接口处理链接文档。

学到更多