企业架构师 (Sparx System) - UseCase 的文档模板答案

【问题标题】：Enterprise architect (Sparx System) - Documentation template for UseCase企业架构师 (Sparx System) - UseCase 的文档模板
【发布时间】：2016-05-26 08:05:10
【问题描述】：

我在为 Enterprise Architect (v 12.1) 创建 UseCase 模板方面需要帮助。我有这样的 UseCase 图，我需要从名为“Transaction”的图生成文档（如您在这张图片上看到的那样）：

问题是，一个 UseCase 位于另一个包中。使用我的模板生成文档时（我的文档中只需要“Transaction”包而不是 Transaction Validation 或其他包），不会生成 Transaction Validation 的 UseCase（只是因为此元素来自另一个包）。

还有一点需要注意 - 我们不编写结构化规范场景，但我们将场景写入“描述”选项卡。喜欢这个：

我尝试创建用于生成位于图表上的元素的模板，但只有在创建模板时为位于图表上的“外来”元素生成 Element.StructuredScenarioText 的选项（我需要红色的值 - ElemScenario.Scenario、ElemScenario。类型和 ElemScenario.Notes）：

是否有任何选项可以为位于图表上的“外国”用例生成场景（非结构化）？

感谢您的帮助！

【问题讨论】：

标签： templates documentation-generation enterprise-architect

【解决方案1】：

要包含元素场景的描述，请选择 RTF 模板部分 package / element / scenario 并插入 Notes 字段。

您的另一个问题，即如何在报告中包含来自其他包的元素，有点棘手。

通常，您会将模板基于图表，并确保在“生成文档”对话框中选择Include all Diagram Elements in Report。

这种情况下的问题是，当您在图表的上下文中记录元素时，您只能访问元素字段的有限子集。对于场景，您仅限于 Element.StructuredScenarioText 字段，在您的情况下该字段为空。如果您在连接器的上下文中记录元素（即连接到正在记录的元素的元素），则可以使用相同的有限字段集，因此您也不能使用它。

最简单的选择是创建一个模板片段。借助片段，您可以使用 SQL 查询或自定义脚本实现您自己的选择，从而将您的文档从包层次结构中解放出来。

或者，您可以从包含所有用例的更高包级别运行生成（在您的情况下为“WO 中的事务”），并在“生成文档”对话框中添加过滤器以仅选择您想要的那些用例.

【讨论】：

另一种选择是使用虚拟文档。然后，您可以使用 (SQL) 搜索来获取您需要的用例，甚至可以为每个用例制作一个模型文档。
这确实是另一种选择，但我认为这比添加片段更大，所以我没有包含它。