验证
模型检查
对整个模型运行 75 项基于规则的检查以及您自己的规则集,按严重程度、类、规则和标签筛选发现项,就地修复,忽略有意为之的发现项,并设置每条规则的严格程度。
本页内容
概述
验证 → 模型检查对项目中的每个条目运行一系列规则,并列出每条规则发现的问题。这些规则查找使模型难以信任或评审的缺口:缺少名称和编号、孤立的条目、无人执行的动作、不承载任何内容的接口、未分配或未验证的需求、没有处理计划的风险,以及未达到阈值的度量。
每当模型发生变化时,检查都会再次运行,因此该页面、主页上的模型检查卡片和验证上的徽标始终一致。
概念
- 规则:一项带编号的检查(例如 Requirement.10),带有说明其发现内容的标题、关于良好模型应是什么样的陈述,以及修复方法。规则按其检查的类分组:Global(每个条目)、Action、Asset、Conduit、Input/Output、Requirement、Risk、Test Case 和 Measure。
- 发现项:违反一条规则的一个条目。发现项可以列出相关条目,例如某个名称的重复项或某个父项的子项。
- 严重程度:每条规则报告为错误或警告,或设为忽略而不运行。默认为“警告”,但在架构副本早于 LML 2.0 的项目中,LML 2.0 规则 Global.10 和 Global.11 除外(参见规则)。
- 已忽略的发现项:您针对某个条目接受的发现项。它不再计数,显示已忽略会将其与 Restore 一起列出。
- 适用检查:至少对其类的一个条目运行过的规则。标题行统计有多少适用检查没有发现项。
- 规则集:您自己的规则的命名组,存储在项目中,并作为一个整体开启或关闭。其规则与内置检查一起运行,其发现项使用相同的列表、修复和忽略。参见规则集。
如何使用
在每次评审之前、大量导入之后,以及每当主页显示模型检查错误时运行检查。它们回答一个问题:在别人阅读之前,模型中有什么需要处理?
逐一处理发现项
- 打开验证 → 模型检查。标题行显示例如“84% of applicable checks pass”,后面是错误和警告的数量以及自上次运行以来的变化。
- 列表按规则分组,错误在前。点击规则标题即可展开;其描述说明该规则为何重要。
- 对于每个发现项,点击修复。修复对话框显示条目、规则和建议的修复:要填写的字段、要添加的关系、要合并的重复项,或打开该条目或其图的按钮。
- 保存修复。发现项消失,计数随之更新。
- 当某个发现项是有意为之时(例如某个动作在两个父项下复用),点击忽略。
聚焦一个领域
- 在左侧的分面中,勾选Severity下的错误,只查看错误。
- 勾选类下的某个类(带有发现项的条目的类)、规则下的某条规则,或标签下的某个标签。同一分面中的勾选以 OR 组合;不同分面之间以 AND 组合。每个值都显示其发现项数量。
- 在筛选发现项中输入内容,以匹配条目名称或规则标题。
- 点击清除分面即可再次显示所有内容。
集中审查一个条目的发现项
- 在筛选旁选择 Group by entity。
- 每个条目只列出一次,并带有其所有发现项,按编号顺序排列。有错误的条目会在其标题中显示错误徽标。
实例:CubeSat EO-1 演示
- 打开 CubeSat EO-1 演示项目,转到验证 → 模型检查。
- 勾选类下的 Requirement。剩下的规则显示哪些需求没有父项、没有分配(Requirement.8)或没有验证测试用例(Requirement.10)。
- 打开 Requirement.10,在某个发现项上点击修复,并关联验证它的测试用例。该发现项离开列表,标题行的百分比随之上升。
- 选择 Group by entity,一次查看某条需求剩余的所有发现项。
编写您自己的规则
- 点击页面标题中的规则集…,然后点击+ 新建规则集。为规则集命名,例如“Program Rules”,然后点击确定。
- 在该规则集下,点击+ 添加规则。规则编辑器以 ID R1 打开。
- 输入一个说明该规则发现什么的名称,例如“Requirements with no verifying test case”。
- 在 Applies to 中选择 Requirement。
- 在在以下情况下报告条目中,选择缺少关系,然后在关系中选择 verified by。
- 将 Severity 设为错误并填写 Message,例如“Link the test case that verifies the requirement.”
- 阅读字段下方的预览,例如“Reports 3 items now: SYS-2 Top Speed, …”。点击保存。
- 点击关闭。该规则的发现项出现在列表中的 R1 下,错误在前。点击修复关联测试用例;该发现项离开列表。
用单位检查质量预算
- 在 CubeSat EO-1 演示项目中,打开规则集…,点击+ 新建规则集并将其命名为“Mass Budget”。
- 点击+ 添加规则。将其命名为“Assemblies over their mass allocation”,并在 Applies to 中选择 Asset。
- 在在以下情况下报告条目中,选择将相关值的合计与某个值比较。将 Function 设为 Total,关系设为 decomposed by,每个相关条目的值设为 Mass,比较设为 is more than,比较对象设为 Mass Allocation。
- 将 Severity 设为错误并点击保存,然后点击关闭。
- 部件质量超过其分配的装配体会被列出,例如“Total Mass of “decomposed by” 2.34 kg is more than Mass Allocation 1.35 kg”。以克和千克为单位的质量可以相加;以米为单位输入的质量会列为“Cannot add mass and length: the dimensions differ (kg vs m).”
与另一个项目共享规则
- 在规则集…中,点击规则集旁的导出。会下载一个名称类似
program-rules.holarch-rules.json的文件。 - 在另一个项目中,打开规则集…,点击导入…,然后点击选择文件…(或粘贴文件文本),再点击导入。
- 要通过库共享,请将规则集保存在库项目中并发布一个版本。在使用该库的项目中,点击从库中…,勾选规则集并点击复制。
- 当库发布了包含该规则集的较新版本时,规则集…会在副本旁显示“A newer version is available”。点击更新…,审查更改,为两处都更改过的每条规则选择保留我的或采用库中的,然后点击更新。您对副本的其他编辑会保留。
提示
- 在设置中,将团队视为阻断性的规则设为错误,使主页将其列为问题。
- 只有在发现项是有意为之时才忽略它,并在条目的描述或评论中说明原因。显示已忽略让评审人员看到哪些内容已被接受。
- 导入后出现的一长串命名发现项,通常在数据库中编辑名称修复得最快。
- 在保存基线之前运行检查,以免基线带有已知缺口。
页面
页面标题区
| 控件 | 功能 |
|---|---|
| 导出… | 打开“导出”对话框,其中包含 Findings (CSV):每个未被忽略的发现项,包括规则、严重程度、标题、条目 ID、编号、名称、类、备注和相关条目。 |
| 设置 | 设置每条规则的严重程度和每层子项数(参见“设置”)。 |
| ↻ 运行检查 | 再次运行每项检查,并将计数记录为上次运行。 |
标题行
- “N% of applicable checks pass”:存在任何错误发现项时为红色,只有警告时为琥珀色,没有需要修复的内容时为绿色。
- 发现项、错误和警告的数量。
- 自此设备上次运行以来的变化,例如“3 findings fewer than the last run.”。在您打开或离开页面时,以及点击↻ 运行检查时,会记录上次运行。首次访问时显示“First run on this device.”
在大型项目中,检查在后台运行,因此页面仍可使用:首次访问时显示“Running the model checks…”,之后的访问会显示之前的发现项,直到新的发现项准备好;运行时间超过一秒时会显示进度卡片。
工具栏
- 按规则分组(默认)或 Group by entity。该选择会在此设备上记住。
- 筛选发现项:匹配条目名称、规则编号和规则标题。
- 全部展开和全部折叠打开或关闭每个组。
分面
| 分面 | 值 |
|---|---|
| 严重程度 | 错误、警告 |
| 类别 | 每个带有发现项的条目的类 |
| 规则 | 每条带有发现项的规则,按编号和标题显示 |
| 标签 | 带有发现项的条目上的每个标签 |
| 已忽略 | 显示已忽略将已忽略的发现项添加到列表中,标记为“已忽略”,并带有 Restore |
计数随其他分面和筛选变化,因此显示的是勾选某个值后会剩下的内容。
发现项
每个发现项显示条目(按实体分组时显示规则)、说明(例如“Vague words: adequate, TBD”或“14 children”)、相关条目,以及修复和忽略按钮,已忽略的发现项则显示 Restore。一次撤销即可撤回一次忽略或恢复。
修复
| 修正 | 适用于 | 功能 |
|---|---|---|
| 编辑字段 | 缺少名称、编号或描述;动词和名词检查 | 打开带有当前值的字段。 |
| 首字母大写 | 小写的名称 | 提供首字母大写的名称。 |
| 添加关系 | 缺少父项、执行者、输入、输出、Conduit、标准、追溯 | 列出架构允许用于该关系的条目;勾选它们并点击添加关系。 |
| 合并 | 相似的名称、单个子项 | 保留一个条目,将其他条目的每个关系移到它上面,合并描述并删除其他条目(一次撤销即可全部撤回)。 |
| 删除相关项 | 输入在使用之后才产生的动作 | 删除在存在之前就被消耗的输入/输出。 |
| 添加 traced to | 提及无关实体的需求 | 从需求向其文本中提到的每个条目添加 traced to。 |
| 创建 Issue | 没有关联 Issue 的失败测试用例 | 创建一个关联到该测试用例及其所验证需求的 Issue。 |
| 打开 | 过长的子项列表、交换、标准、阈值、架构不允许的关系 | 打开该条目或其图。 |
| 打开 UAF 视图 | 无法显示的 UAF 视图 | 列出根的视图及其问题,并打开第一个。 |
设置
- 每层子项数:Action.9 和 Asset.9 会报告子项多于此数字的父项。默认为 9,依据是人们在同一层级大约能处理 7 ± 2 个条目的准则。允许的值为 2 到 99;其他值会显示“Children per level must be a whole number from 2 to 99.”
- 每条规则的严重程度:错误、警告或忽略。被忽略的规则不会运行。
- 恢复默认值将每条规则恢复为其默认值(警告;Requirement.11 为忽略;在架构副本早于 LML 2.0 的项目中,Global.10 和 Global.11 为忽略),并将每层子项数恢复为 9。
设置存储在项目中,与项目中的每个人共享,并且可以撤销。
规则集
页面标题中的规则集…打开“规则集”对话框。您自己的规则与内置检查一起在模型检查中运行:其发现项显示规则的 ID(例如 R1)和名称,计入标题行,出现在分面的规则下,并像任何发现项一样使用修复、忽略和导出…。规则集存储在项目中,与项目中的每个人共享,每次更改都是一个撤销步骤。
“规则集”对话框
| 控件 | 功能 |
|---|---|
| + 新建规则集 | 询问名称,并添加一个已开启的空规则集。 |
| 导入… | 添加规则集文件中的规则集:选择文件…或粘贴其文本,然后点击导入。每条规则都会先经过检查;有问题的文件会被拒绝,并列出问题。已使用的名称会加上“ (2)”。 |
| 从库中… | 列出此项目所用库的各版本中的规则集;勾选它们并点击复制。副本会记住其库和版本。 |
| 更新… | 当复制的规则集所在的库发布了包含该规则集的较新版本时,显示在该规则集旁(“A newer version is available”)。预览库中添加、更改和移除的规则,您所做的会被保留的编辑,以及在此处和库中都更改过的规则;为其中每条选择保留我的或采用库中的,然后点击更新。一次撤销即可全部撤回。 |
| 规则集旁的复选框 | 开启或关闭该规则集。关闭的规则集不会运行。 |
| 重命名… | 重命名该规则集。 |
| 导出 | 将该规则集下载为 JSON 规则集文件。 |
| 删除 | 确认后删除该规则集及其规则。撤销可恢复它们。 |
| + 添加规则、编辑、删除 | 向规则集添加规则、更改规则或删除规则。 |
无法在此项目中运行的规则(例如指定了架构中不存在的类或关系的规则)会在其名称下以红色显示问题,并且不报告任何内容。
规则编辑器
| 字段 | 设置内容 |
|---|---|
| 姓名 | 规则发现项的标题:该规则发现什么。 |
| ID | 在规则集中简短且唯一,例如 R1 或 SYS-NUM;最多 40 个字母、数字、点、短横线和下划线。 |
| Applies to | 任意条目、某个类(包括子类:Test Case 也是 Action),或在 SysML v2 项目中为某种模型类型,例如 Part 或 Requirement。 |
| 仅匹配以下条件的条目 | 可选:用数据库筛选语言编写的筛选,先缩小条目范围,例如 is:leaf。 |
| 在以下情况下报告条目 | 条件,见下文。 |
| 严重程度 | 错误或警告。 |
| 留言 | 要进行的修复,显示在“修复”对话框中。 |
字段下方的一行说明该规则当前报告多少个条目,并列出前五个的名称。
| 条件 | 字段 | 在以下情况下报告条目 |
|---|---|---|
| 属性为空 | 属性 | 该属性没有值。 |
| 属性匹配模式 | 属性、模式、忽略大小写 | 属性的文本包含与该模式(一个正则表达式)匹配的内容。 |
| 属性不匹配模式 | 属性、模式、忽略大小写 | 属性的文本没有匹配项,例如对于必须以 SYS- 开头的编号,使用 ^SYS-\d+$。 |
| 缺少关系 | 关系、条目所属类 | 该条目没有该关系的关联(到该类的条目)。 |
| 存在关系 | 关系、条目所属类 | 该条目有这样的关联。 |
| 相关条目数至少为 N | 关系、条目所属类、N | 该条目有 N 个或更多相关条目,例如多于 9 个子项。 |
| 相关条目数至多为 N | 关系、条目所属类、N | 该条目有 N 个或更少相关条目。 |
| 值在范围外 | 属性、最小值、最大值、单位 | 属性的数值低于最小值或高于最大值。将一个边界留空即为开放范围。 |
| 值在范围内 | 属性、最小值、最大值、单位 | 属性的数值在范围内(包括边界)。 |
| 将相关值的合计与某个值比较 | Function、关系、条目所属类、每个相关条目的值、比较、比较对象 | 相关条目上某个值的 Total、最小或最大(或条目数)大于、至少为、小于、至多为、等于或不同于该条目的某个属性(例如 Mass Allocation)或某个带单位的值(12 kg)。没有该值的相关条目会被跳过。 |
| 表达式匹配 | 表达式 | 该条目与表达式匹配。 |
属性的命名与条目上相同:名称、Number 和描述(在 SysML v2 项目中为 Short Name 和文档),或该类的任何属性。在 SysML v2 项目中,也可以指定元素的属性用法,例如 mass。类中没有该属性的条目会被跳过。LML 条目的值还包括它 specified by 的特性(Value 为 2.4、Units 为 kg 的 Mass 特性读作 2.4 kg)以及其预算分配(Mass Allocation,来自预算)。没有单位时,范围读取值开头的数字(1,500 kg 和 1500 [kg] 读作 1500),并跳过不是数字的值。有单位(例如 kg)时,值会先换算(25000 g 读作 25 kg),而另一种类型的值(例如 3 m)本身就是一个发现项:“Cannot compare length and mass: the dimensions differ (m vs kg).”合计和表达式以相同方式换算单位,并以相同方式报告不匹配,绝不会静默比较。
表达式规则
表达式使用数据库筛选栏的筛选语言编写,因此在那里能找出问题条目的筛选也可以作为规则使用:每个匹配的条目都会被报告。示例:
| 表达式 | 报告 |
|---|---|
class:Requirement is:leaf NOT relationship:"verified by" | 没有测试用例验证的叶需求。 |
class:Requirement Requirement:"Status=Draft" | 仍处于 Draft 状态的需求。 |
class:Action is:root NOT relationship:"performed by" | 没有任何项执行的顶层动作。 |
class:Asset (name:%TBD% OR description:TBD) | 名称或描述中带有 TBD 的资产。 |
class:Asset value:"sum(decomposed by → Mass) > Mass Allocation" | 部件质量超过其分配的装配体,可使用任意单位组合。 |
带单位的算术运算:value:"Mass * 1.1 <= 12 kg" 或 value:"sum(decomposed by → Mass) > Mass Allocation" 比较条目的值以及其相关条目上的合计(sum、min、max、count),可使用 +、-、*、/、括号以及数字后的单位(12 kg、9.81 [m/s^2])。带单位的属性比较(例如 Asset:"Mass>2 kg")也会换算。
条件项:自由文本、name:(% 匹配任意文本)、number:(* 匹配任意文本)、description:、class:、label:、relationship:"…"、status:、id:、under:"<number>"、is:root、is:leaf、is:orphan、is:top、is:locked、is:diagram,属性比较例如 Requirement:"Priority>=3"(=、~ 包含、<、<=、>、>=;不带值的 = 表示为空),AND、OR、NOT 以及括号。在项目中不指向任何内容的条件项(例如未知的类)会显示为问题。
规则集文件
规则集文件是 JSON,包含 "format": "holarch-rule-set"、"version": 1、一个 name、一个可选的 description 和一个 rules 列表,每条规则都有 id、name、severity、message、一个可选的 target({"class": "Requirement"})、一个可选的 where 筛选和一个 check。导出一个规则集即可查看确切的结构。相同的文件也可在公共 API 和 MCP 的模型检查中运行。它们也可在 SysML v2 项目上运行:在那里,API 和 MCP 只运行项目的规则集(内置规则在应用中运行),而针对 Holarch 从连接和流中读取的关系(connected by、transfers、generates、receives)的规则只在应用中运行。
规则
| 规则 | Heading | 良好的模型 |
|---|---|---|
| Global.1 | 相同或几乎相同的名称 | 在同一类中,没有两个实体同名。名称在任何语言中进行比较,忽略大小写、空格、标点和字符宽度(“ABS制御”等同于“ABS制御”);带重音的字母会区分(“Größe”和“Grüße”不同)。 |
| Global.2 | 小写的名称 | 每个实体名称都以大写字母开头。 |
| Global.4 | 类中重复的编号 | 同一类中,每个编号都是唯一的。 |
| Global.5 | 名称或描述中的模糊词语 | 名称和描述使用精确的词语。 |
| Global.6 | 没有关系的实体 | 每个实体都有关系。 |
| Global.7 | 指向缺失目标的实时值 | 实时值、矩阵块、实时表格(表格、计数和合计)以及描述中的交叉引用都指向存在的实体、文档、类、标签、关系、图和表。 |
| Global.8 | 无法显示的 UAF 视图 | 每个 UAF 视图都使用其视图类型接受的根、类和关系。 |
| Global.9 | 架构不允许的关系 | 每个关系都连接架构允许该关系类型使用的类。 |
| Global.10 | 既没有名称也没有编号的实体 | 每个实体都有名称或编号。 |
| Global.11 | 超出其属性选项的值 | 每个枚举值和多选值都是其属性的选项之一,且只选择一次。 |
| Action.1 | 不以动词开头的 Action 名称 | 每个 Action 名称都以动词开头。 |
| Action.2 | 小写的 Action 名称 | 每个 Action 名称都以大写字母开头。 |
| Action.3 | 缺少名称的动作 | 每个动作都有名称。 |
| Action.4 | 缺少编号的动作 | 每个动作都有编号。 |
| Action.5 | 缺少描述的动作 | 每个动作都有描述。 |
| Action.6 | 没有父项或子项的动作 | 每个动作都有父项或子项。 |
| Action.7 | 只有一个子项的动作 | 没有动作只有一个子项。 |
| Action.9 | 子项超过 9 个的动作 | 没有动作的子项超过 9 个。 |
| Action.10 | 有多个父项的动作 | 没有动作拥有多个父项。 |
| Action.11 | 没有资产执行的动作 | 每个动作都由某个资产执行。 |
| Action.12 | 不产生任何东西的动作 | 每个动作都产生一个输入/输出。 |
| Action.13 | 不消耗任何东西的动作 | 每个动作都消耗一个输入/输出。 |
| Action.14 | 没有输入或输出的动作 | 每个动作都消耗或产生一个输入/输出。 |
| Action.15 | 只产生而不消耗任何东西的动作 | 每个产生输出的动作也会消耗一个输入。 |
| Action.16 | 只消耗而不产生任何东西的动作 | 每个消耗输入的动作也会产生一个输出。 |
| Action.17 | 输入在使用之后才产生的动作 | 没有动作接收由后续动作生成的输入/输出。 |
| Action.18 | 未追溯到需求的动作 | 每个动作都追溯到一个需求。 |
| Action.19 | 永远无法结束的循环 | 每个循环都可以结束。会指出该循环以及阻止其 EXIT 的 0 % OR 分支。 |
| Asset.1 | 不含名词的资产名称 | 每个资产名称都是名词或名词短语。 |
| Asset.2 | 小写的资产名称 | 每个资产名称都以大写字母开头。 |
| Asset.3 | 缺少名称的资产 | 每个资产都有名称。 |
| Asset.4 | 缺少编号的资产 | 每个资产都有编号。 |
| Asset.5 | 缺少描述的资产 | 每个资产都有描述。 |
| Asset.6 | 没有父项或子项的资产 | 每个资产都有父项或子项。 |
| Asset.7 | 只有一个子项的资产 | 没有资产只有一个子项。 |
| Asset.9 | 子项超过 9 个的资产 | 没有资产的子项超过 9 个。 |
| Asset.10 | 有多个父项的资产 | 没有资产拥有多个父项。 |
| Asset.11 | 不执行任何动作的资产 | 每个资产都执行某个动作。 |
| Asset.12 | 未通过管道连接的资产 | 每个资产都通过管道连接。 |
| Asset.13 | 相互交换但没有共同管道的资产 | 交换输入/输出的资产通过管道连接。 |
| Asset.14 | 相互作用但没有共同标准的资产 | 相互作用的资产引用同一标准。 |
| Asset.15 | 不交换任何东西的资产 | 每个资产都与另一个资产交换输入/输出。 |
| Conduit.1 | 不以名词开头的管道名称 | 每个管道名称都以名词开头。 |
| Conduit.2 | 缺少名称的管道 | 每个管道都有名称。 |
| Conduit.3 | 缺少编号的管道 | 每个管道都有编号。 |
| Conduit.4 | 缺少描述的管道 | 每个管道都有描述。 |
| Conduit.5 | 连接两个以上资产的管道 | 没有管道连接两个以上的资产。 |
| Conduit.6 | 资产少于两个的管道 | 每个管道都连接两个资产。 |
| Conduit.7 | 与其资产没有共同标准的管道 | 管道及其连接的资产引用同一标准。 |
| Conduit.8 | 不传输任何东西的管道 | 每个管道都传输某个输入/输出。 |
| Conduit.9 | 未追溯到需求的管道 | 每个管道都追溯到一个需求。 |
| IO.1 | 缺少名称的输入/输出 | 每个输入/输出都有名称。 |
| IO.2 | 缺少编号的输入/输出 | 每个输入/输出都有编号。 |
| IO.3 | 缺少描述的输入/输出 | 每个输入/输出都有描述。 |
| IO.4 | 有多个父项的输入/输出 | 没有输入/输出拥有多个父项。 |
| IO.5 | 没有动作产生的输入/输出 | 每个输入/输出都由某个动作产生。 |
| IO.6 | 没有动作消耗的输入/输出 | 每个输入/输出都由某个动作消耗。 |
| IO.7 | 没有动作使用的输入/输出 | 每个输入/输出都由某个动作产生或消耗。 |
| IO.8 | 同一动作既产生又消耗的输入/输出 | 没有动作消耗其自身产生的输入/输出。 |
| IO.9 | 与其资产没有共同标准的输入/输出 | 输入/输出及交换它的资产引用同一标准。 |
| IO.10 | 未追溯到需求的输入/输出 | 每个输入/输出都追溯到一个需求。 |
| Requirement.1 | 提及无关实体的需求 | 需求与其中提到的每个实体都有关系。 |
| Requirement.2 | 不含“shall”的叶需求 | 每个叶需求都使用“shall”一词。 |
| Requirement.3 | 缺少名称的需求 | 每个需求都有名称。 |
| Requirement.4 | 缺少编号的需求 | 每个需求都有编号。 |
| Requirement.5 | 缺少描述的需求 | 每个需求都有描述。 |
| Requirement.6 | 没有父级或子级的需求 | 每个需求都有父项或子项。 |
| Requirement.7 | 有多个父级的需求 | 没有需求拥有多个父项。 |
| Requirement.8 | 没有设计实体满足的叶需求 | 每个叶需求都关联到 Action、Asset、Input/Output 或 Conduit。 |
| Requirement.9 | 由多个 Input/Output 满足的需求 | 没有需求由多个输入/输出满足。 |
| Requirement.10 | 没有验证测试用例的叶需求 | 每个叶需求都由 Test Case 验证。 |
| Requirement.11 | 不符合 EARS 模式的需求 | 每条带有“shall”的叶需求都遵循某种 EARS 模式。在您设置其严重程度之前为关闭(忽略)。 |
| Risk.1 | 没有缓解措施的最高级别风险 | 风险矩阵最高级别上的每个未关闭风险都由某项内容缓解。 |
| Risk.2 | 早于控制措施变更的危险源接受 | 没有危险源的剩余风险接受早于对其控制措施或其验证的更改。 |
| TestCase.1 | 没有关联 Issue 的失败测试用例 | 每个失败的 Test Case 都关联到一个 Issue。 |
| Measure.1 | 突破阈值的 Measure | 每个 Measure 的预测值(或当前值)都满足其阈值。 |
关于规则的说明:
- 需求编写规则引用了 INCOSE《需求编写指南》:模糊词语(R7,模糊术语;R8,免责条款)、“shall”(R1,结构化陈述)和大写字母(R39,风格指南)。完整的编写检查请参见需求质量。
- Action 和 Asset 规则会跳过任务、测试用例、状态转换、端口和资源;Global 规则仍然适用于它们。
- 已分解的条目只要其任何后代满足条件,就算作已执行、有输入、有产出或已追溯。在循环中相互分解的条目一起计算。
- Global.9 对每个条目只报告一次,并列出其架构不允许的关系的另一端,在说明中给出关系和类,例如“Not allowed: decomposed by → Risk”。只要架构允许任一方向,关系就算作允许。在架构编辑器中移除某个目标后,这样的关系仍会保留,也可能随导入而进入。
- Global.10 和 Global.11 来自 LML 2.0:实体通过名称或编号来标识(§2.1),枚举或多选值从其属性的列表中选取(§2.5.6、§2.5.12)。Global.11 将一个条目的所有问题都放在其说明中,例如
Status: "Pending" is not a choice或Verification Method: "Test" chosen twice。在架构带有 LML 2.0 内置项的地方(默认架构,或在架构 → 添加新的内置项…之后的项目自有副本),两者默认运行。在架构副本较旧的项目中,它们开始时为忽略,因此用 LML 1.x 构建的模型显示与以前相同的发现项;在设置中将其设为“警告”或“错误”即可运行它们。架构编辑器在您创建或更改列表时要求至少两个值。 - 端口是接口点,不是部件:它们不计为子项,端口上的 Conduit 计入拥有该端口的资产。
- 用例(带有 Use Case 标签的 Action)不受动词规则和输入/输出规则约束。
- Requirement.11 根据六种 EARS 模式检查包含“shall”的句子(用 EARS 模板编写),并指出首先要修复的内容,例如“Event-driven: Put a comma after the “When” condition, before the system name.”其他句子中的理由和说明不检查。
- SysML v2 项目以 SysML v2 的术语运行其中 17 条规则:Global.1、.2、.4 到 .8,Requirement.2 到 .5、.8、.10 和 .11,Risk.1、TestCase.1 和 Measure.1。Action、Asset、Conduit 和 Input/Output 规则不适用;编辑器的诊断会检查模型的名称、类型和结构。需求规则检查需求用法:例如 Requirement.8 显示为“Leaf requirements nothing satisfies”(满足它的部件或动作),Requirement.10 显示为“Leaf requirements with no verification case”。Global.1、.2 和 .6 检查模型旁边的条目,例如风险、任务和文档。
产品线规则
一旦项目有了 Feature 或 Configuration,模型检查还会运行内置规则集产品线(规则 ProductLine.1 到 ProductLine.11 以及 13 到 17,类为产品线)。Applies To 中缺少特性或配置(ProductLine.1)、违反规则或不完整的配置(ProductLine.3),以及带有未在其中验证的需求的 Released 配置(ProductLine.16)属于错误;其他规则为警告。ProductLine.10 和 11 从“所有配置”检查每个配置的完整性。ProductLine.13 和 14 检查条目的修订版(supersedes):同一单元同时有两个生效,以及单元没有任何生效修订版。在配置视图中,每条规则都检查该配置。参见产品线和配置。
消息
| 留言 | 含义 |
|---|---|
| “No findings. Every applicable check passes.” | 没有需要修复的内容。 |
| “No findings. N findings ignored; Show ignored lists them.” | 其余的每个发现项都已被忽略。 |
| “No finding matches the filter. Clear the filter or the facets.” | 分面或筛选隐藏了所有发现项。 |
| “The schema allows none of these relationships for the class …” | 该修复需要项目架构不允许该类使用的关系。请在架构编辑器中添加它,或用其他方式修复该发现项。 |
| “The pattern is not a valid regular expression (…). Correct it.” | 规则编辑器或导入的文件中有无法读取的模式。 |
| “The id “…” is already used in this rule set. Choose another.” | 同一规则集中的两条规则需要不同的 ID。 |
| “The relationship “…” is not in this project's schema.” | 规则指定了此项目没有的关系;在您更改它之前,它不报告任何内容。 |
| “The expression names nothing for class “…”.” | 表达式或筛选指定了项目中没有的类、标签、关系或条目。 |
| “Version N is not supported. This version of Holarch reads version 1.” | 规则集文件由较新版本的 Holarch 写入。 |
限制
- 列表中每组最多显示 200 个发现项;筛选列表即可查看其余部分。
- 一个规则集最多包含 500 条规则;一个文件最多包含 50 个规则集,大小不超过 2 MB。模式最多 300 个字符,检查值的前 20,000 个字符。
- 自上次运行以来的变化按设备和浏览器保存,而不是保存在项目中。
- 公共 API 和 MCP 工具使用项目的设置返回相同的发现项;它们不存储结果。