模型
架构和扩展
通过自定义类、属性、选项、关系、标签和状态工作流来定制项目的 LML 架构,并查看每项更改对现有数据的影响。
本页内容
概述
架构定义了项目的模型可以包含的内容:
- 实体的类,
- 每个类拥有的属性,
- 可以连接各类的关系,
- 用于标记实体的标签,
- 可选的工作流:每个类的状态属性的各个状态、它们如何变化,以及哪些变化需要审批。
每个项目都从默认的生命周期建模语言(LML)架构开始。架构编辑器只为一个项目更改它。第一次编辑会创建项目自己的副本,因此其他项目不受影响。每次架构编辑都可通过一次撤销撤回。
Holarch 还会为每个项目添加内置扩展,例如需求上的优先级和所有者,以及风险上的 Handling Strategy。请参阅内置扩展。
有关日常处理实体、属性和关系,请参阅模型和数据库。
概念
项目架构
- 默认架构:Holarch 自带的 LML 类、关系、属性和标签。应用内帮助主题LML 类(架构)、LML Relationships (schema)和Labels (schema)会针对打开的项目实时列出它们。
- 项目架构:存储在项目内的副本。它在第一次编辑时创建,随项目一起导出,并提供给每个打开该项目的成员。
- 内置扩展:Holarch 的功能所需的附加内容。每次打开项目时按名称应用。因此大多数项目已经有了自己的副本,使用情况页面显示 “此项目使用自己编辑过的架构。”
课程
类是一种实体,例如 Requirement 或 Asset。它有名称、描述、父类和颜色,以及两个标志(抽象和隐藏)。
- 父类:子类继承其父类的属性和关系目标。它会出现在涵盖父类的每个查询、筛选和图中。例如,Action 的自定义子类可以使用动作图。Requirement 的自定义子类可以使用质量检查和审批控件。
- 抽象:该类用于对子类分组,无法直接创建。
- 隐藏:在创建实体或更改其类时不提供该类。它及其子类不会出现在数据库的类筛选中。现有实体保持不变。
- 颜色:类徽标和色块的颜色。没有设置时,自定义类使用其最近的内置祖先类的颜色。徽标显示名称的前两个字母。
属性
属性是某个类的每个实体都具有的字段,例如需求上的优先级。属性也可以属于某个关系。
属性有名称、类型以及在类的顺序中的位置。它可以有允许的值、默认值和描述。将指针指向属性标签时会显示描述。
类型,按属性对话框中的列出方式分组(方括号中为存储的类型 ID;导出、导入和 API 使用它):
| 组 | 类型 | 内容 |
|---|---|---|
| 文本 | 短文本 (TEXT)、长文本 (BIG_TEXT)、富文本 (HTML) | 单行;多行;带格式的文本 |
| 数字 | 数字 (NUMBER)、百分比 (PERCENT)、持续时间 (DURATION) | 数字或分布;0 到 100;带时间单位的数字或分布 |
| 日期和时间 | 日期和时间 (DATETIME) | 日期和时间 |
| 选项 | 列表之一 (ENUMERATION)、列表中的多项 (MULTISELECT)、是或否 (BOOLEAN) | 一个值;多个值;是或否 |
| 链接 | 网址 (URI)、文件 (FILE) | 一个链接;一个上传的文件 |
| 特殊 | 位置 (GEOPOINT)、方程 (EQUATION)、计算值 (COMPUTABLE)、人员或团队 (USER_TEAM)、多重性 (MULTIPLICITY)、质量检查 (QUALITY) | 纬度和经度;LaTeX 文本;根据其他实体的属性计算出的值;人员或团队名称;n、n..m、n..* 或 *;由质量检查设置的 Yes/No 准则 |
每种类型的编辑器在属性类型和编辑器中介绍。
从父类继承的属性排在最前,然后是该类自己的属性,按各类页面上设置的顺序排列(拖动一行,或使用↑ / ↓)。新属性排在最后。
已隐藏的属性会保留其值。它会从编辑器、筛选条件、列、搜索和报告中消失,直到再次显示。
关系和目标
- 关系总是成对出现:一个名称和一个逆名称,例如 satisfies / satisfied by。创建一个会同时创建两者。
- 目标允许从一个类到另一个类的关系,例如 Requirement verified by Test Case。指向某个类的目标同样允许其子类。子类继承其父类的目标。
- 关系可以带有属性,例如 decomposed by 上的多重性。添加到关系上的属性也适用于其逆关系。
- 已隐藏的关系在架构编辑器中以变暗方式显示,并且不会出现在帮助的参考列表中。它仍然可以使用。
标签
标签是您加在实体上的标记,例如 Stakeholder Need。它不添加字段,也不改变任何结构。
标签有名称、描述以及其适用的类。它可以有一个父标签,因此标签可以嵌套。
- 未选择任何类时,标签适用于所有类。
- 适用于某个类的标签也适用于其子类。
- 已隐藏的标签保留在已带有它的实体上,但不再提供。
工作流
工作流控制类的某个 ENUMERATION 属性如何变化,通常是状态。它包括:
- 状态:该类使用的值,按顺序排列。您可以添加、重命名、重新排序和移除自定义状态。内置状态(例如需求的已审批)只能退役。属性为继承而来的子类(例如 Requirement 下的 Software Requirement)保留其自己的状态。
- 转换(从 → 到):允许的变化。没有转换时,任何状态都可以跟在任何其他状态之后。
- 转换上的审批:该变化需要一个已审批的变更请求。默认由变更请求 → 设置中设置的审批人决定。转换也可以改为指定自己的审批人:所有者、编辑者或指定的人员,以及其中必须有多少人审批(最多 5 人,或所有指定人员)。
- 此转换后锁定条目(在转换的⋯菜单中):条目在该变化之后被锁定。
然后该属性的编辑器只提供当前值和允许的下一个状态。需要审批的状态显示为(需要审批)。
如何使用
何时使用及原因
在项目开始时定制架构:在确定建模方法时,以及在导入数据之前。典型原因:
- 采用某种方法或标准:添加您的流程所需的属性,例如资产上的 TRL 或需求上的安全完整性等级。添加您的文档模板所需的标签。
- 细分类:添加子类,例如 Risk 下的 Hazard 或 Asset 下的 Payload Instrument。这样查询、筛选和报告就能区分它们,而它们保留所有 LML 关系。
- 允许方法所需的关系:添加一个目标,或一对新的关系。
- 强制执行评审流程:添加一个工作流,使需求的状态按 草稿 → 评审中 → 已审批 推进。这样编辑器就绝不允许跳过某一步。将 评审中 → 已审批 标记为审批,使这一变化经过项目的审批人。
- 跨项目重用:从一个项目导出架构,再导入到下一个项目中。
架构回答的问题是 “这个模型能表达什么?”。请审慎地更改它。查询、已保存的列、报告和导入都按名称引用类、属性和关系。
为类添加属性
- 在导航栏中,点击设置 → 架构(位于底部的工具中)。
- 在侧栏的类下,点击该类,例如 Asset。
- 在属性卡片中,点击+ 属性。
- 输入名称。
- 选择类型,例如“选项”下的列表之一。
- 对于列表之一或列表中的多项:在允许的值中输入选项,每行一个。
- 可选:设置默认值。该类的新实体以此值开始。
- 可选:输入描述。
- 点击添加属性。
您会看到提示消息 “已保存属性”。该属性位于该类列表的最后,并会出现在该类及其子类中:属性面板、条目视图、数据库的列和筛选条件、搜索、报告以及导入映射。
- 要移动它,请在属性表中拖动其所在行,或使用该行上的↑和↓。每次移动都可通过一次撤销撤回。
为现有属性添加选项
- 打开定义该属性的类。定义于列会显示它。继承的属性要在定义它的类上编辑。
- 点击该行上的✎(编辑属性)。
- 在允许的值中,将新选项单独写成一行。
- 点击保存。
对于列表之一,每个选项前面的方块(在列表下方)设置该值的颜色。以该属性的值作为列的看板会将其用作列的颜色。
要移除某个选项,请在同一对话框中删除其所在行。已有该值的实体会保留它,但编辑器不再提供它。在移除选项之前,请用属性查询(例如 Requirement:"Priority=Urgent")找出这些实体,并为它们指定一个现有的选项。
创建子类
- 打开父类。
- 点击+ 子类。
(或点击侧栏中的+ 类,然后选择父类。)
- 输入名称和描述。
- 根据需要设置抽象、隐藏和颜色。
- 点击创建类。
您会看到新类。它已具有所有继承的属性和目标。
要将现有实体移入新类,请在数据库中选中它们并使用更改类…。请参阅更改类。
添加标签
- 点击侧栏中的+ 标签,或标签页面上的+ 新建标签。
- 输入名称和描述。
- 如果该标签属于另一个标签之下,请选择那个父标签。
- 选择它适用的类。⌘ / Ctrl/Ctrl+点击可选择多个。未选择任何类时,该标签适用于所有类。
- 点击创建标签。
要应用该标签,请使用属性面板或条目视图中的+ 标签,或数据库批量操作栏中的标签 ▾。
允许新的关系
只有当某个目标允许时,两个类之间的关系才被允许。添加一个目标即可允许它。
- 打开源类。
- 在关系中,点击+ 关系。
- 选择关系。
- 选择另一个类。
- 保持勾选同时向另一个类添加反向关系。这样就可以从任一端建立关联。
- 点击添加关系。
如果另一个类缺少反向关系,返回此类列会显示+ on <class>:点击它即可在那里添加反向关系。
如果您需要的关系不存在,请先创建它:
- 点击对话框中的新建关系类型…(或侧栏中的+ 关系)。
- 输入名称和反向名称,以及它们的描述。
- 点击创建关系。
- 在上面的第 3 步中选择新的关系。
定义状态工作流
- 点击侧栏中的工作流。
- 在添加类…中选择该类。
您会看到该类的卡片。工作流监视该类的第一个枚举属性。
- 如有需要,请在监视列表中选择其他属性。更改它会清除转换。
- 点击+ 添加转换。
- 设置转换的名称、从和到。从为(初始 — 无值)或某个状态。
- 如果该变化需要一个已审批的变更请求,请勾选审批。要在变化之后锁定条目,请打开该行的⋯菜单(或右键点击该行),然后选择此转换后锁定条目;该行随即显示锁定条目。
- 对每个允许的步骤重复第 4 到 6 步。
要选择由谁审批转换,请参阅选择转换的审批人。
该属性的编辑器现在只提供允许的下一个状态,并标记为⇢ 工作流。
添加或更改工作流的状态
- 在工作流页面上,找到该类的卡片。条目列统计每个状态中的条目数;没有值的条目计入该属性的默认值(没有状态的测试用例计为未运行,与测试中心的显示方式相同)。
- 要添加状态,请在新状态中输入其名称,然后点击+ 添加状态。
该状态会被添加到该类以及该属性的选项中。
- 要对状态排序,请点击↑或↓。选择器和看板列遵循此顺序。
- 要重命名自定义状态,请点击重命名…并输入新名称。
处于该状态的条目、转换以及值的颜色都会使用新名称。一次撤销即可全部撤回。
- 要移除状态,请点击移除…(自定义状态)或停用…(内置状态)。
- 没有任何条目处于的状态会被移除。
- 当有条目处于该状态时,请选择移动并移除并指定要将它们移到的状态,或选择保留为已退役。已退役的状态保留在其条目上,显示(已停用),且不再提供。其出站转换保留,因此条目可以离开该状态。恢复可使其再次被提供。
此页面上的任何更改都不会清除值。
选择转换的审批人
- 在工作流页面上,勾选该转换上的审批。
其旁边会出现一个按钮:变更请求设置 ▾。
- 点击该按钮。
转换审批者随即打开。
- 在审批人中,选择以下之一:
- 按变更请求 → 设置中的设置:由项目的审批人决定(默认)。
- 所有者或所有者和编辑者。
- 指定人员:勾选进行审批的项目成员。在桌面应用中,输入他们的名字,以逗号分隔,与每个人在偏好设置 → 您的名字中输入的一致。
- 在所需审批数中,选择必须有多少人审批:1 到 5,或所有指定人员。
- 点击保存。
按钮会显示该规则,例如全部 3 位指定人员 ▾。一次撤销即可撤回该更改。
包含多个状态更改的请求需要满足所有适用的规则。任何有权审批的人拒绝一次即拒绝该请求。在托管服务上,只有当项目所有者最后设置了工作流时,指定的审批人才有效;否则该转换需要同样数量的所有者审批。
为状态更改请求审批
- 在属性面板或条目视图中,选择一个标记为(需要审批)的状态。对于需求,您也可以点击评审条中的转换(以…结尾)。
请求审批随即打开。
- 可选择输入原因,然后点击提交请求。
系统会创建并提交一个包含该状态更改的变更请求。对话框会列出其审批人:转换自己的审批人,或变更请求 → 设置中设置的审批人。条目保持其原状态。
在请求未关闭期间,需求的评审条会显示该请求及其计数,例如CR-4:3 项审批中已有 1 项。
- 审批人审批该请求。
在最后一项审批之后,如果该审批人可以编辑项目,条目就会进入新状态。否则由一名编辑者打开该请求并点击应用更改。条目的历史记录会显示via CR-n,需求的审批记录会列出每位审批人以及该请求。
对此类状态的直接更改会被拒绝,并显示 "… needs approval. Choose "X" on the item to request it."(需要审批。请在条目上选择 X 来请求审批。):包括批量属性…、网格单元格、看板移动和 AI 更改。在请求未关闭期间再次选择该状态会打开那个请求。
在项目之间共享架构
- 在源项目中,打开导航栏中的设置 → 架构。
- 点击导出架构。
一个 JSON 文件随即下载。
- 在目标项目中,打开导航栏中的设置 → 架构。
- 点击更多 ▾ → 导入架构…并选择该文件。
- 选择模式:
- 合并(按名称匹配,添加此项目缺少的类、属性、关系和标签),或
- 替换此项目的架构。
- 点击导入。
实例:CubeSat EO-1
本示例为资产添加技术成熟度等级(TRL),细分一个类,并添加一个评审工作流。使用管理项目 → 项目文件 ▾ → 新建演示项目创建演示项目,然后打开导航栏中的设置 → 架构。
查看模型。
- 阅读使用情况页面。
类表格首先列出最常用的类,并显示其条目、属性和关系。尚未使用列出演示项目未使用的类、标签和关系。
为资产添加 TRL。
- 点击 Asset,然后点击+ 属性。
- 输入名称
TRL,并选择类型列表之一。 - 在允许的值中输入选项
1到9,每行一个。 - 输入描述
Technology readiness level。 - 点击添加属性。
填写该属性。
- 打开架构 → 资产。
- 选择 1.2.1 Reaction Wheel Assembly,并在属性面板中将 TRL 设为
7。 - 用同样的方式将 1.2.2 Star Tracker 设为
6,将 1.1 Payload Camera 设为5。查询它。
- 在搜索框中输入
Asset:"TRL>=6"并按 Enter。查询变成查询栏中的一个筛选标签。表格列出反作用轮和星敏感器。数字形式的选项值按数字比较。
细分一个类。
- 回到架构编辑器,打开 Asset 并点击+ 子类。
- 将其命名为
Payload Instrument,然后点击创建类。 - 在数据库中,勾选 1.1 Payload Camera 并点击更改类…。
- 选择 Payload Instrument 作为新类。
对话框显示 “1 个条目将变为 Payload Instrument。”,并且没有列出要移除的内容:该子类继承了每个 Asset 属性和目标。
- 点击更改类。
相机保留其 TRL、其 performs 关联以及其在分解结构中的位置。
添加一个评审工作流。
- 打开工作流,并在添加类…中选择 Requirement。
- 确认它监视的是状态。
- 添加以下转换:初始 → 草稿、草稿 → 评审中、评审中 → 已审批、评审中 → 已拒绝、已拒绝 → 草稿。
- 打开 2.4 Target Slew。其状态为草稿。
其状态列表现在只提供草稿和评审中。
撤销或保留。
- 每项更改按一次 ⌘Z / Ctrl+Z 即可撤销这次试验。或者保留这些更改,并点击导出架构,以便在下一个 CubeSat 项目中重用。
提示和良好做法
- 优先使用子类和标签,而不是新的顶层类。子类保留其父类的所有 LML 关系、图和检查。标签完全不改变任何结构。
- 隐藏而不是删除。隐藏类、属性或标签可保持现有数据完整,并且可以撤销。
- 在导入之前设置好架构。导入映射提供已存在的属性。映射到新建属性的列会被自动创建,并使用推测的类型。请参阅导入和导出。
- 保留内置附加内容。隐藏您不需要的内置扩展。不要重命名或删除它:缺失的内置扩展会在下次打开项目时以空值重新添加。
- 说明每个自定义元素,写在其描述中。它会作为编辑器中的工具提示以及帮助的架构表格中显示。
- 小于类的属性测试也会匹配没有值的实体。例如,
Asset:"TRL<6"包括没有 TRL 的资产。请将此类测试与正向测试结合使用,或对补集使用>=。
常见错误
- 更改属性的类型会清除其值。Holarch 会警告 "N entities have a "X" value. Changing the type from A to B clears those values."(N 个实体具有 X 值。将类型从 A 更改为 B 会清除这些值。)如果您需要旧值,请先导出 CSV 报告。一次撤销即可将类型更改和被清除的值一并撤回;在有超过 5,000 个此类值的项目中,清除期间会显示进度卡片。
- 删除关系会删除其所有关联。确认消息会统计它们。撤销可恢复它们。
- 移除目标会留下架构不再允许的关系。现有关联保持不变;模型检查会在规则 Global.9(架构不允许的关系)下列出它们。在移除目标之前或之后,请移除它们或更改其关系;确认消息会统计它们。
- 类中仍有实体时无法删除。请先更改这些实体的类或将其删除,或者隐藏该类。
- 普通转换只对编辑器起引导作用。批量属性…、导入和 AI 更改仍可设置任何不需要审批的状态。当某项变化不得绕过评审时,请将转换标记为审批。
- 内置状态无法重命名。审批、配置控制和验证都依赖于它们。请改为添加一个新状态,或停用该内置状态。
与其他功能的关联方式
- 数据库、属性面板和条目视图显示和编辑属性。它们提供架构允许的关系。查询按名称引用类、属性、标签和关系。请参阅模型和数据库。
- 图:实体可以拥有的图类型取决于其类及其上级类。自定义子类会继承这些图类型。
- 需求功能(质量、审批、TBD/TBR、待评审的关联)依赖于内置属性,例如状态、TBD/TBR和质量准则。请参阅需求。
- 可追溯性矩阵和模型检查使用关系目标来判断哪些是允许的、哪些是缺失的。请参阅可追溯性。
- 导入和导出按名称映射到属性,并在项目 JSON、
.holarch和 ReqIF 文件中携带架构。请参阅导入和导出。
架构编辑器
架构编辑器是您进行所有架构更改的地方。从导航栏中的设置 → 架构(位于底部的工具中)打开它。地址 schema?class=<id> 可直接打开某个类(之前的内置类编号仍然有效)。
编辑器包含页面标题栏、侧栏和主区域。主区域显示使用情况页面、某个类,或关系、标签或工作流页面。
页面标题区
| 控件 | 功能 |
|---|---|
| 导出架构 | 将项目的架构下载为 JSON(<Project_name>_schema.json)。 |
| 更多 ▾ → 导入架构… | 用合并或替换导入架构 JSON 文件(也可以是包含架构的项目 JSON)。 |
| 添加新的内置项… | 在项目有自己的架构时显示。列出默认架构中有而此副本中缺少的类、关系、属性和标签(按名称匹配),例如 LML 2.0 新增的内容,以及现有项的 LML 2.0 值和允许的关系(Decision Status 的 Open 和 Closed;Logical decomposed by Logical;Connection transfers Input/Output),并添加它们,一次撤销即可全部撤回。现有的类、属性、选项和数据保持不变;新值排在现有值之后。 |
| 更多 ▾ → 重置为默认… | 在项目有自己的架构时提供。确认后将其替换为默认的 LML 架构。 |
侧栏
- 搜索类、属性、关系、标签…可筛选类树。主区域显示匹配的类、属性、找到的关系和找到的标签,或显示 “没有匹配的类、属性、关系或标签。请尝试其他搜索词。”
- 使用情况。
- + 类、+ 标签、+ 关系。
- 类:类树,带有颜色色块、“(abstract)” 和 “(hidden)” 标记,以及实体数量(包括子类)。
- 其他:关系(带计数)、标签(带计数)和工作流。
用法
首先打开的是使用情况。其状态行显示 “默认 LML 架构。首次编辑时会为此项目创建副本。” 或 “此项目使用自己编辑过的架构。”
- 类:一张未隐藏的类的表格,最常用的在前:类(点击可打开)、条目(包括其子类)、属性(其自身的)、关系(允许的,包括继承的)和上次更改(其某个条目最后一次更改的时间)。
- 尚未使用:三个可展开的列表,即项目中没有任何内容使用的类、标签和关系,每个都带计数。行上的隐藏会隐藏该类、标签或关系对(一次撤销即可全部撤回);隐藏的项保留在架构中,可在其页面或对话框中再次显示。
类页面
点击侧栏中的某个类即可打开其页面。从上到下依次为:
- 父类的导航路径。点击其中一个即可打开它。
- 标题:类图标和名称、抽象和隐藏标签、✎ 编辑类、+ 子类和删除。项目中有 N 个实体 ›会打开按该类筛选的数据库。
- 描述卡片:描述,标签 Id N、属性 N(部分来自父类时带有 “(k inherited)”)、关系 N和实体 N,以及子类。
- 属性卡片:+ 属性以及一张包含以下列的表格:
- 该类自身属性的排序控件:拖动行,或使用↑ / ↓(每次移动都可通过一次撤销撤回)。
- 名称、类型(类型的名称;将指针指向它可查看存储的 ID)。
- 详细信息:选项和默认值。
- 定义于:“this class” 或祖先类。
- 描述。
- 针对在此类上定义的属性的操作:✎(编辑属性)、⊘ / 👁(隐藏属性 / 显示属性)和×(移除属性)。
- 关系卡片:+ 关系以及一张包含两个方向的表格:关系、其他类、返回此类(反向名称,以及对缺少反向关系的其他类显示的+ on <class>)和描述。在其他类中,× 可移除在此类上定义的关系。继承的关系显示 “(inherited from X)”。
- 标签卡片:该类可用的标签。
*标记在所有类上都可用的标签。
编辑类对话框
标题为创建新类或编辑类 — X。字段:名称、描述、父类((无 — 顶层)或某个类)、隐藏、抽象和颜色。点击创建类或保存类。
有实体的内置类无法更改其父类:“条目使用此内置类,因此其父类是固定的。”
属性对话框
标题为新建属性或编辑属性 — X。对于关系属性,标题会加上 “(relation “…”)”。点击添加属性或保存。
- 名称和类型(分组:文本、数字、日期和时间、选项、链接、特殊)。没有顺序字段:新属性排在最后。
- 允许的值(每行一个):仅适用于“列表之一”和“列表中的多项”。空行和重复的值会被删除。列表至少需要两个值:"An enumeration needs at least two choices. Add another choice."(枚举至少需要两个选项。请再添加一个选项。)(对于“列表中的多项”为 "A multiselect …")。已经只有一个值的属性,在其列表未更改时仍可保存。对于“列表之一”,列表后面每个值都有一个颜色方块。
- 默认值:不适用于 FILE、COMPUTABLE、QUALITY、HTML 和 USER_TEAM。
- 描述。
关系页面
点击侧栏中的关系可查看每一对关系。该页面有+ 关系以及一张包含以下列的表格:
- 关系和反向。
- 源 → 目标:允许的每一对类。
- 属性:每个属性的 ✎,以及+ 属性。
- 已使用:关系的数量。
- 描述。
- ✎(编辑关系)和×(删除关系)。
关系对话框的标题为新建关系或编辑关系 — X。它包含名称、反向名称、描述、反向描述、隐藏和颜色(或默认颜色)。Spider 图用此颜色绘制该关系;单个图仍可为每个关系选择自己的颜色。关系列以色块显示该颜色。编辑时,它还会列出该关系的属性,并带有+ 添加属性。点击创建关系或保存。
标签页面
点击侧栏中的标签可查看每个标签。该页面有添加 DoDAF 标签和添加 UAF 标签(此项目缺少的框架标签;在创建第一个 DoDAF 产品或 UAF 视图时也会添加它们)、+ 新建标签,以及一张按树状顺序排列、包含以下列的表格:
- 标签。
- 适用于:类标签或 “所有类”。
- 实体:计数。
- 描述。
- 操作:✎(编辑标签)、⊖(从所有实体上去掉此标签,在使用中时显示)和×(删除标签)。一次撤销即可将标签放回到其被去掉的每个实体上;超过 5,000 个实体时会显示进度卡片。
标签对话框的标题为创建新标签或编辑标签 — X。它包含名称、描述、父((无)或某个标签)、类(未选择时:所有类)和隐藏。点击创建标签或保存标签。
工作流页面
点击侧栏中的工作流。页面显示 "Set which value changes an enumeration attribute (such as Status) allows."(设置枚举属性(例如状态)允许哪些值的变化。)
页面显示 “设置类的状态,以及状态之间哪些更改是允许的或需要审批。”
添加类…列出具有枚举属性但尚无工作流的类。当类有状态属性时,工作流监视它。每个工作流类都有一张卡片,包含:
- 类标签、监视以及被监视的属性。当工作流已有转换时,更改它会先询问。
- 移除:移除该类的工作流。条目的值保持不变。
- 状态:一张表格,包含状态(标记为内置或(已停用))、条目(计数)以及↑、↓、重命名…、移除…或停用…,或恢复。其下方是新状态和+ 添加状态。属性为继承而来的子类会显示 “X 自身的状态;Y 为继承。”
- 转换:+ 添加转换会添加一个从(初始 — 无值)到第一个状态的 “New Transition”。表格包含:名称、从、到、审批,以及一个⋯菜单,其中有此转换后锁定条目和删除转换(也可右键点击该行,或在其上按 ⇧F10 / Shift+F10)。名称、从和到以文本形式显示;点击其中之一(或在其上按 Enter 或 F2)即可更改。没有转换时,卡片显示 “没有转换:任何状态都可以跟随任何其他状态。”
在托管服务上,只有项目所有者可以更改工作流;其他人看到的是只读页面,并显示 “只有项目所有者可以更改工作流。”
架构更改如何影响现有数据
在更改已有数据的架构元素之前,请查看此表。
| 变更 | 对实体和关系的影响 |
|---|---|
| 重命名类、属性、关系或标签 | 数据会保留,因为所有内容都按 ID 存储。使用旧名称的已保存查询、搜索文本和列标题将不再匹配。请更新它们。 |
| 更改类的父类 | 在编辑器中,该类获得新父类的属性和目标,失去旧父类的属性和目标。已存储的值保持不变。对有实体的内置类不允许此操作。 |
| 将类标记为抽象或隐藏 | 现有实体保持不变。该类不再用于新实体或更改类。 |
| 删除类 | 仅当该类没有子类且没有实体时才允许。其自身的属性和目标会被移除。标签会将它从其类列表中去掉。 |
| 添加属性 | 现有实体没有值。新实体获得默认值。 |
| 更改属性的类型 | 确认后,该属性的所有值都会被清除。 |
| 移除选项 | 实体保留旧值。编辑器不再提供它。 |
| 隐藏属性 | 值会保留,但在再次显示之前不会被显示、搜索或导出。 |
| 移除属性 | 确认后,每个实体和关系上的该值都会被清除。 |
| 添加目标 | 该关系在这些类(及其子类)之间变为可用。 |
| 移除目标 | 现有关系保持不变,尽管架构不再允许它们。模型检查规则 Global.9 会列出它们。 |
| 删除关系 | 该关系对、其目标以及使用它的每个关系都会被移除。 |
| 删除标签 | 它会从每个实体上移除。其子标签上移到其父标签之下。 |
| 导入架构(合并) | 按名称添加缺失的类、关系、目标、属性和标签。现有内容不会被更改或移除。 |
| 添加新的内置项 | 按名称添加默认架构中缺失的类、关系、属性和标签,并使用其默认 ID。会为添加的类和关系添加目标,另外还有现有类之间的 LML 2.0 目标;LML 2.0 的 Decision Status 值会被追加。现有内容不会被更改或移除。 |
| 导入架构(替换)或重置为默认 | 架构被替换。实体数据保留,但已不存在的属性的值不会显示。内置扩展会在下次打开项目时重新添加。 |
每项更改都可通过一次撤销撤回,⌘Z / Ctrl+Z 会恢复架构以及它所移除的所有数据。
内置扩展
Holarch 在每个项目打开时为其添加这些元素,因为其功能需要它们。
- 它们按名称匹配,不区分大小写。
- 它们只在缺失时才会被添加,绝不会被重命名或移除。
- 您对它们的编辑会被保留。
| 类别 | 添加的属性 |
|---|---|
| 需求 | 优先级和 Criticality(High、Medium、Low)、所有者、Source、TBD/TBR(None、TBD、TBR)、TBD Owner、TBD Due Date、Verification Method(多选:Analysis、Demonstration、Inspection、Test)、验证级别(Component、Subsystem、System)、成功标准 |
| Risk | 所有者、Handling Strategy(Accept、Avoid、Transfer、Mitigate、Watch)、Residual Probability、Residual Consequence、Need-by Date、Trigger、关闭理由;状态增加选项 Mitigating 和 Watch |
| Test Case | 测试人、测试日期、配置、被测件、Test Evidence(文件) |
| 任务 | Board Column(枚举),在创建或转换带有自定义列名的看板时添加。其值为各列的名称。 |
| Input/Output | Data Rate、Data Rate Units、Protocol/Format、Message/Data Definition |
| Conduit | Connector/Pins、Medium、所有者、Interface Status(Draft、Proposed、Agreed、Baselined)、TBD/TBR(None、TBD、TBR) |
| Port | Conjugated |
| 指标 | Weight、Improvement Direction(N/A、Positive、Negative)、Scoring Method(Direct 1-10、Direct 1-5、Linear、Thresholds)、Score Thresholds、当前估计 |
| 决策 | 状态(Open、In Analysis、Decided、Deferred、Superseded)、Decision Date、Decided By |
| 特性 | Units |
| Asset | Quantity |
添加的标签:Stakeholder Need 和接口需求(Requirement)、Interface Block(Asset,位于 Block 之下)、Trade Study 和白板(Artifact)、标准和 TPM(Measure)。
添加的关系目标:Decision alternative Asset、Action、Artifact、Resource、Statement 和 Requirement,逆关系为 alternative of。
框架页面(DoDAF 和 UAF)会在您第一次添加此类产品时创建其产品所用的标签。
键盘快捷键
| 按键 | 位置 | Action |
|---|---|---|
| Enter | 属性对话框中的允许的值字段 | 开始下一个选项(每行一个) |
| ⌘ / Ctrl/Ctrl+点击 | 标签对话框中的类列表 | 选择多个类 |
| ⌘ / Ctrl+Z / ⌘ / Ctrl+Shift+Z | 任何位置 | 撤销 / 重做架构更改 |
选项和设置
- 项目架构存储在项目中,并与每个能打开该项目的成员共享。
- 具有查看者角色的成员无法更改它("View only: ask an owner for edit access.",即仅查看:请向所有者申请编辑权限)。
- 导出架构文件使用
holarch-schema格式,包含类、关系、属性、标签和工作流。
消息
| 留言 | 含义和解决方法 |
|---|---|
| “请输入类名称。” | 类名称为空。 |
| “该类名称太长;请缩短。” | 类和标签名称限制为 100 个字符。 |
| "Class names cannot contain : " ( ) < or >. Searches give these characters a meaning."(类名称不能包含 : " ( ) < 或 >。这些字符在搜索中有特殊含义。) | 请删除这些字符。其他字母、数字、空格和标点符号都是允许的。现有的类名称仍然有效。 |
| “另一个类已使用此名称。请选择其他名称。” | 类名称是唯一的(不区分大小写)。 |
| ""X" is a search keyword (as in x:…). Choose another class name."(X 是一个搜索关键字(如 x:…)。请选择其他类名称。) | 搜索键(class、label、name、number、description、is、relationship、in、under、diagram、id、order)以及 AND、OR、NOT 不能用作类名,因为搜索会将该类读作这个键。 |
| “该父类会使此类成为其自身的祖先。” | 请选择该类子树之外的父类。 |
| “此类有子类。请先删除它们或将其移到其他父类下。” | 有子类的类无法删除。 |
| ""X" (or a subclass) has N entities. Change their class or delete them first, or hide the class."(X(或其子类)有 N 个实体。请先更改它们的类或将其删除,或者隐藏该类。) | 有实体的类无法删除。 |
| “请输入属性名称。” | 属性名称为空。 |
| “属性名称包含不允许的字符。” | 请使用字母、数字、空格以及 _ - $ ( ) . , /。 |
| "Name, Number and Description are built in; pick another attribute name."(名称、编号和描述是内置字段;请选择其他属性名称。) | 这些是实体字段,不是属性。 |
| “此处已存在同名属性。” | 该类、某个父类或某个子类已有此属性。 |
| "Add at least one choice."(请至少添加一个选项。) | ENUMERATION 和 MULTISELECT 需要选项。 |
| “请输入标签名称。” / "The label name contains characters that are not allowed."(标签名称包含不允许的字符。)/ "Another label already uses this name."(另一个标签已使用此名称。)/ "A label cannot be inside itself. Choose another parent."(标签不能位于其自身之内。请选择其他父标签。) | 标签对话框的检查。标签还可以使用 & 和 '。 |
| “请输入关系名称和反向名称。” / "The relation name and the inverse name must be different."(关系名称和反向名称必须不同。)/ "A relation named "X" already exists."(名为 X 的关系已存在。) | 关系对话框的检查。 |
| “不是 JSON 文件。” / "This file is not a schema: it needs classes, relations, attributes and labels."(此文件不是架构:它需要包含类、关系、属性和标签。) | 导入架构…需要架构或项目 JSON 文件。 |
| “已合并架构:添加了 N 项” / “已替换架构” | 导入已完成。 |
| “没有工作流类。请通过“添加类…”选择一个类以定义其状态和转换。” | 尚未定义任何工作流。 |
在进行破坏性更改之前,确认消息会说明其后果:
| 确认 | 文本 |
|---|---|
| 移除属性 | "N entities have a value that will be cleared."(N 个实体有将被清除的值。) |
| 更改类型并清除值 | "N entities have a "X" value. Changing the type from A to B clears those values."(N 个实体具有 X 值。将类型从 A 更改为 B 会清除这些值。) |
| 删除类 | “删除类“X”及其属性和目标?” |
| 移除目标(其他类中的 ×) | "N existing relationship(s) stay, although the schema no longer allows them."(N 个现有关系将保留,尽管架构不再允许它们。) |
| 删除关系 | "N relationship(s) using it are removed too."(使用它的 N 个关系也会被移除。) |
| 删除标签 | "It is removed from N entities."(它将从 N 个实体上移除。) |
| 从条目移除标签 | "Remove "X" from N entities?"(从 N 个实体上移除 X?) |
| 重置架构 | “自定义的类、属性、关系和标签将从架构中移除(条目数据保留;可撤销)。” |
限制
- 类和标签名称:100 个字符。
- 由导入创建的属性名称:80 个字符。
- 每个类一个被监视的属性。
- 普通转换由属性编辑器、网格单元格和看板执行。审批转换还会拒绝直接更改和批量更改。新条目可以在任何状态下创建。
- 锁定适用于 LML 条目。SysML v2 元素不会被锁定。
- 状态名称:100 个字符。
- 合并不会为已存在的属性添加新选项;请在属性对话框中添加。
- 添加新的内置项…只有在架构变为自定义之后,再次打开该页面时才会出现。