控制与评审
变更请求
以变更请求的形式对已审批或已建立基线的条目提出变更,经评审和审批后一步应用,并留有完整记录。
变更请求提议对模型进行一组编辑,说明原因,并在任何内容更改之前等待审批。变更请求用于配置控制:需求一旦获得审批或设置了基线,更改就需通过由项目审批人评审的请求进行。变更请求位于控制与评审 → 变更请求下。
如何使用
创建变更请求
- 打开控制与评审 → 变更请求,然后点击页面标题栏中的+ 新建变更请求;或者在受配置控制的条目的条目视图中,点击页面标题栏中的提议更改…(如果该条目已有未关闭的变更请求,则会打开它)。
- 为其填写标题和原因:为何需要该更改以及它要达到什么目的。
- 点击创建,然后用添加条目…添加受影响的条目。Holarch 会列出追溯到它们的条目(需求、测试、接口和其他相关条目);对同样需要更改的条目点击 +。
暂存更改
- 点击添加更改 ▾并选择要提议的内容:更改条目…(编号、名称、在富文本编辑器中编辑的描述(因此保留其格式),或一个属性)、新建条目…、删除条目…、添加关系…、移除关系…、添加指向另一个项目的链接…或移除指向其他项目的链接…。在 SysML v2 项目中,编辑 SysML 文本…会提议对一个包的文本进行编辑。
- 点击暂存更改。每个已暂存的更改都会列在提议的更改下,描述和文本更改带有逐词差异,并附有其影响列表(参见影响)。此时模型中尚未有任何更改。
- 用移除移除已暂存的更改。
提交、评审和审批
- 点击提交评审。在托管服务上,审批人会收到通知,并在我的工作 → 待决定下出现一项,其中的审批…和拒绝…会打开该请求及其投票对话框。
- 审批人打开请求,检查提议的更改及其影响列表,然后点击审批…或拒绝…(拒绝需要原因)。如果更改的需求在某个基线中,审批…对话框还会列出需要重新评审的验证条目和文档。
- 评审卡片显示审批:N / M。如果请求的状态更改有其自己的审批人,还会列出每条规则及其计数,例如○ 每位指定审批人 (3):1 / 3。当请求获得所需的审批后,其状态变为已审批。一次拒绝即会拒绝该请求;之后作者可以编辑更改并再次提交。
撤回会关闭尚未应用的请求,而不更改模型;其记录保留在日志中。
应用更改
- 编辑者或所有者打开已审批的请求并点击应用更改,然后用应用更改确认。
- 所有已暂存的更改会一起应用,一次撤销即可全部撤回。每个已更改条目的历史记录会记下该更改“via CR-12”。
- 其条目在此期间已被删除的更改会被跳过,并随结果一起列出。已暂存的配置发布(添加更改 ▾ → 发布配置…)会连同请求的审批人一起记录,或列出未发布的原因;参见通过变更请求发布。
- 请求会保留每个更改在应用之前那一刻的影响列表,作为所考虑内容的记录。其历史记录会显示“impact recorded”及计数,例如“4 affected, 9 to check”。应用从不等待影响列表:如果几秒后仍在读取其他项目中的条目,请求会立即应用,并保留截至当时计算出的列表,在请求、其历史记录和导出中标记为“Impact not finished when applied”。
在变更请求中工作
您可以在草稿变更请求中工作,而不必在对话框中逐个暂存更改:像平常一样在任意页面上编辑模型,您的编辑会进入该请求,而不是实时模型。只有在请求获得审批并应用后,实时模型才会更改。
启用
在变更请求中工作对每个项目默认关闭,直到项目所有者将其启用:在变更请求页面上打开设置,勾选在变更请求中工作:在草稿中编辑,审批后应用。当某个草稿中仍有在其中所做的编辑时,无法将其关闭;请先应用或撤回这些请求。在托管服务上,在变更请求中工作随项目所有者的 Team 方案提供,与审批规则相同(参见配置控制下的说明):经过验证的学术邮箱地址或活跃班级组织的成员资格也包含此功能,且在 2.29.0 版之前使用过审批规则的项目会保留它。在其他方案上,该设置显示为禁用。桌面应用没有方案。
开始和离开
可以从以下任一位置开始在草稿请求中工作:
- 新建变更请求对话框中的立即在其中工作(默认勾选)。
- 草稿请求页面上的在此变更请求中工作。
- 条目的条目视图中的提议更改 ▾ → 在变更请求中工作…。列表显示指定了该条目的草稿,以及新建变更请求…。
- 编辑受配置控制的条目时显示的消息中的在变更请求中工作。
- ⌘K / Ctrl+K → 在变更请求中工作…。
- 我的工作 → 我正在处理的变更请求下的继续。
在请求中工作时:
- 顶栏下方的横幅会显示,例如正在 CR-12 Range upgrade 中工作。编辑会进入此变更请求,而不是实时模型。3 项更改。,并带有评审更改和离开。
- 保存状态会显示,例如14:02 已保存在 CR-12 中。
- 请求所更改的条目在表格和图中带有 CR 标记。
要试用,请打开 CubeSat EO-1 演示项目:CR-1 Shorten the planning cycle 是一个其中已有编辑的草稿。在变更请求下打开它,然后点击在此变更请求中工作。在 Hybrid Car 演示中,CR-2 Clarify the charge time 包含对一条需求文档的编辑。
点击横幅中的离开(或 ⌘K / Ctrl+K → 离开变更请求)返回实时模型。该模式属于浏览器标签页:另一个标签页可以同时显示实时模型,重新加载后标签页仍停留在请求中。
有哪些不同
- 撤销最多回到您进入请求的位置。
- 在您离开请求之前,架构更改、基线、共享、请求审批和恢复以前的版本都会被拒绝。
- 受配置控制的条目可以在请求中编辑;这正是它的用途。
- 提交评审会暂停编辑,直到请求被决定或撤回。被拒绝的请求在您编辑它时会重新成为草稿。
- 撤回会将请求的编辑作为一项移到回收站,例如CR-12 changes;恢复会将它们放回请求中。
评审更改
其中有编辑的请求在其页面上有两个标签页:详细信息(请求、已暂存的更改、评审、评论和历史记录)和更改,后者将请求之前的模型与请求将产生的模型进行比较。横幅中的评审更改会打开它。
- 计数磁贴显示新增、移除和更改的条目以及关系更改;其下方每项更改各占一行,更改的文本逐词显示。
- 质量结果、可疑链接标记和其他评审记录会被隐藏;点击显示评审数据也可列出它们。
- 文档列出包含已更改条目的每个文档。比较版本…显示请求前后的文档,每个字段并排显示并标记更改的词语;在字段内移动的句子会在两个位置以紫色显示,并在它们之间带有链接。
- 图列出每个已更改的图及其更改内容,例如Asset Diagram 0 Drone Delivery System:新增 1 个形状(Charger),移动 1 个。显示前后对比会并排绘制两个版本。
请求页面上的在模型中预览会以只读方式打开应用请求后的模型。横幅会显示,例如正在预览 CR-12(只读)。每个页面都会就地显示更改,因此您可以检查生成的规格说明、RVTM 或矩阵。在您点击离开之前,编辑会被拒绝。评审者和查看者也可以预览。
投票既涵盖在请求中所做的编辑,也涵盖其已暂存的更改:投票后所做的编辑会使该投票作废,审批人需重新决定。
应用您在其中工作过的请求
对已审批的请求点击应用更改时,会先将其编辑与当前的实时模型进行比较,因为其他人可能在此期间更改了相同的条目。
- 无冲突:确认信息会显示,例如将 14 项更改应用到实时模型?一次撤销即可全部撤回。点击应用更改后,提示消息显示已应用 CR-12:14 项更改。新条目保留其 id,每个已更改条目的历史记录会显示“via CR-12”并列出请求的作者。
- 对同一条目不同字段的更改会直接合并,不会询问:如果请求重命名了某个条目,而其他人在实时模型中更改了它的编号,两项更改都会保留。
- 冲突:同一字段在两边都被更改、条目在一边被删除而在另一边被更改,或者请求中的链接指向在实时模型中已删除的条目。请求页面会统计冲突数,例如CR-12 与实时模型有 2 个冲突。,并且应用更改会先打开解决冲突 — CR-12。
在解决冲突中,每个有冲突的条目都有一张卡片,显示实时模型版本(在托管服务上还会显示更改者)和变更请求版本;显示原始内容会添加两边更改之前的版本。图会并排绘制。选择以下之一:
- 保持实时:条目保持实时模型中的样子。对于指向已删除条目的链接,不保留该链接。
- 使用变更请求:采用请求对其更改的每个字段的值;只有实时模型更改的字段保留其实时值。对于删除,采用请求的结果:条目被删除,或带着请求的更改被恢复。对于指向已删除条目的链接,该条目会连同链接一起从回收站恢复。
- 合并:每个更改的字段一行,带有实时和变更请求。只有一边更改的字段初始选中那一边;两边都更改的字段初始选中变更请求。
在每个冲突都有选择之前,应用更改保持禁用(“为 3 个冲突中的每一个选择版本。”)。只有具有编辑权限的请求审批人才能解决冲突;其他人会看到,例如CR-12 与实时模型有 3 个冲突。审批人会在应用时解决它们。请求的历史记录会记录每个选择(“Kept the live version of R.4.2”、“Replaced a live change by Ann to R.4.3”),在托管服务上,实时更改被替换的人会收到通知。
一次撤销即可撤回整个应用:它会恢复实时模型,并将请求连同其编辑设回已审批,可再次应用。应用后,请求的更改标签页会保留已应用内容的列表。审批后又被编辑的请求,在重新提交并获得审批之前不能应用。请求被应用时正在其中工作或预览它的任何人都会返回实时模型。在 SysML v2 项目中,确认信息会列出请求将给模型增加的任何错误,并且在您选择其他版本或请求被拒绝之前,应用更改保持禁用。
影响
每个已暂存的更改都有一个影响列表:追溯到它的条目,在任何人审批或应用该更改之前就已找出。其标题显示计数,例如影响 3 项受影响 · 7 项待检查。点击标题可显示或隐藏列表。包含三项以上更改的请求,列表初始为收起状态。
列表分为需求、测试和验证、接口、文档、图、其他项目中的条目和其他条目。每一行都有标记:
| 标记 | 含义 |
|---|---|
| 受影响 | 更改触及它:与已更改条目相距一个关系的条目、显示已更改条目的文档或图、新增或移除的关系的两端,以及其他项目中与已更改条目关联的条目。 |
| 检查 | 再远一步:追溯到受影响条目的条目、显示这些条目的文档和图,以及其他项目中相距两个链接的条目。 |
每一行都注明其类以及到达它的方式,例如“verified by 1.1 Pump pressure”。指向另一个项目的链接,如果其条目在上次评审该链接之后有更改,会显示已更改。点击一行可打开该条目、文档或图。其他项目中的条目来自条目追溯,并按您自己的访问权限:指向您无法打开的项目的链接只计数。
一个列表最多显示 300 行,并说明还有多少行。只为前 12 个已更改的条目读取指向其他项目的链接。
标题下方有一条说明,指出列表的依据:“Impact is based on modeled relationships; unlinked or more distant dependencies may not appear. Computed against revision 1,204 at 14:02.” 修订号是计算列表时项目的修订号(在托管服务上,每位编辑者的编号相同)。如果在您阅读时模型发生更改,列表保持计算时的样子;重新打开请求即可重新计算。已保存的列表会保留其计算所依据的修订号。
请求被应用时,列表会随其一起保存并按当时的样子显示,因此即使条目被重命名或删除,记录仍能说明当时考虑了什么。导出 ▾ → Word (.docx) 包含这些列表,Excel 日志中有一个带计数的影响列。
在其他等待决定的更改处也会出现同样的列表:
状态
| 状态 | 含义 |
|---|---|
| 草稿 | 正在编写;作者暂存更改。 |
| 已提交 | 等待审批人。 |
| 评审中 | 至少有一位审批人已投票。 |
| 已审批 | 审批数已足够;可以应用。 |
| 已拒绝 | 某位审批人拒绝了它;作者可以修改后再次提交。 |
| 已撤回 | 已关闭,未更改模型。 |
| 已实施 | 更改已应用。 |
配置控制
注意:在托管服务上,由项目所有者的方案决定。配置控制(第一项设置)随 Individual 和 Team 方案提供;下方的审批规则(所需审批数、审批人、变更委员会、自我审批)随 Team 方案提供。经过验证的学术邮箱地址或活跃班级组织的成员资格可保留两者。在 2.29.0 版之前使用过这些功能的项目和组织会保留它们。没有审批规则时,变更请求按一条规则工作:由项目所有者的审批决定,且作者可以审批自己的请求,因此您独自工作时可以审批并应用自己的更改。之前保存的设置会保留但不会生效,设置中会说明这一点;此时已审批和已纳入基线的条目可以直接编辑。审批记录、投票和状态会保留。桌面应用没有方案。
变更请求页面标题栏中的设置会打开变更请求设置。其中的设置分为配置控制(哪些内容需要变更请求,以及编辑者是否在草稿中工作)和审批(需要多少审批、由谁审批、自我审批)两组;每项设置在更改时即生效,完成会关闭对话框。列表上方的一行说明设置当前的作用,例如“已审批和已纳入基线的条目可以直接编辑;需要项目所有者的 1 项审批。”,并带有在设置中更改链接。
在设置中,项目所有者可以启用更改已审批和已纳入基线的条目需要变更请求。之后:
- 已审批的需求(状态为 Approved)和最新项目基线中的条目不能再直接编辑、删除或关联。Holarch 会说明原因并指向变更请求。
- 它们的适用于、适用性和配置成员关系(产品线)也属于它们的一部分:更改某个条目适用于哪些配置或单元需要变更请求。
- 评论、评审、需求审批、质量结果和链接评审标记保持开放。
- 已审批的变更请求会将其更改应用到这些条目。
- REST API 和 MCP 遵循相同的规则:脚本对这些条目的直接更改会被拒绝(
409 change-control),AI 客户端的提议也不能包含它们。请改为在变更请求中提议该更改。 - 在托管服务上,服务器会检查到达它的每项更改,包括离线时所做的更改。对已审批或已纳入基线的条目所做的更改,如果是在该条目受控之前做出的(离线时,或在其他人审批它期间),则不会被保存:Holarch 会说明是哪个条目,重新加载项目,并保留您的其他更改。请改为在变更请求中提议该更改。
注意:在托管服务上,服务器对每种编辑方式(应用、REST API 和 MCP)强制执行配置控制;编辑者无法通过其他客户端绕过它。只有应用已审批的变更请求才能更改这些条目。在桌面应用和浏览器项目中,由应用强制执行,与条目锁定相同。
审批和审批人
- 所需审批数:1、2 或 3。
- 由谁审批:项目所有者、所有者和编辑者,或由指定项目成员组成的变更委员会(托管服务;在桌面应用上由您审批自己的请求)。变更委员会可以指定评审者:他们可以审批、拒绝和评论该请求,但不能编辑模型。每个可以评论的项目成员(评审者或以上)都可以评论变更请求。
- 作者可以审批自己的变更请求:默认关闭。
只有项目所有者可以更改这些设置。
相同的设置也适用于工作流创建的请求:在架构 → 工作流中标记为审批的状态更改会打开请求审批,它会创建并提交一个只包含该更改的变更请求。
工作流转换也可以指定其自己的审批人,例如评审委员会的每位成员,或 4 名指定工程师中的 2 名(选择转换的审批人)。这样,请求需要获得其状态更改所属每条规则的审批;没有转换覆盖的更改使用这些设置。在桌面应用上,审批人是名称:您以偏好设置 → 您的姓名中的名称进行审批。只包含状态更改的请求,如果最后一位审批人具有编辑权限,会在其审批时立即应用。
在托管服务上,Holarch 只使用项目所有者保存的设置;其他人更改的设置会被忽略,并采用默认值(由所有者审批、一项审批、不能审批自己的请求)。
当 Holarch 没有提交变更请求者的记录时(例如在连同其请求一起上传或导入的项目中),只有项目所有者可以审批它。没有保存者记录的设置,在所有者再次保存之前,按所有者为审批人且不允许自我审批的方式生效。
审批记录
在托管服务上,审批或拒绝时会要求输入密码(每 10 分钟一次),并记录由谁决定、何时决定、备注以及该投票所针对的确切暂存更改。如果投票后暂存更改被编辑,该投票不再计数,并会再次征求审批人。在应用更改之前,服务器会检查请求是否以其当前更改获得了审批。每次投票还会写入审计日志(请求、决定和备注的长度;不包括备注本身)。
注意:审批记录显示谁在何时审批了什么。它不是受法律监管的电子签名(例如 21 CFR Part 11 规定的电子签名)。
评论、通知和日志
- 变更请求上的评论与条目上的评论用法相同。
- 在托管服务上,请求提交时通知会发送给审批人,请求获得审批或被拒绝时发送给作者,请求被应用或撤回时发送给作者和投票者。
- 每个请求都保留一份历史记录,记录发生了什么、由谁以及何时。
- 变更请求页面上的导出 ▾(有变更请求后显示)可将变更请求日志保存为 Excel (.xlsx) 或 Word (.docx),包含每个请求的更改和历史记录。