关系流程图
规格
| 标签 | 值 |
|---|---|
| 版本 | 2.2.0（更新于 2023-07-05） |
| 开发者 | Labii Inc. |
| 类型 | 章节 |
| 支持配置 | 是 |
概述
关系流程图章节小插件可显示 Labii 记录如何通过 ForeignKey 和 ForeignKeys 列相互连接。它将关联记录转换为流程图，帮助用户快速了解上游和下游关系，例如某个项目存储在何处、样本如何经过各处理步骤，或哪些记录构成最终结果。该小插件特别适合样本谱系、存储层级、库存关系、过程可追溯性，以及任何需要了解记录上下文的工作流程。
使用场景
- 样本谱系：跟踪样本与衍生物料、检测、文库、结果或报告之间的连接。
- 存储层级：显示实验室、冰箱、架子、盒子和样本位置等关系。
- 库存可追溯性：显示批次、批号、试剂和耗材如何关联到实验或生产记录。
- 过程记录：绘制实验或运营工作流程涉及的上游和下游记录。
- 数据审查：帮助审查人员检查关联记录，无需手动打开每个表和关系列。
界面
只读视图
只读视图将配置的记录关系显示为流程图。每个方框代表一条 Labii 记录，每条连接线代表所选的 ForeignKey 或 ForeignKeys 关系。
- Record Nodes：将关联记录显示为流程图中的方框。
- Relationship Lines：显示记录如何通过配置的关系列相互引用。
- Connector Text：配置文本列后，在方框之间显示可选文本。
- Clickable Records：用户点击流程图中的方框时打开记录详细信息。
- Directional Layout：使用配置的图表方向和箭头方向显示关系路径。
该小插件实时搜索关联记录。大型关系网络的加载时间可能比简单的一对一路径更长。
编辑视图
编辑视图用于配置流程图应跟随的关系列，以及图表应如何显示这些连接。
- Column：选择用于构建流程图的 ForeignKey 或 ForeignKeys 列。
- Text Column：选择在相连方框之间显示的文本。
- Direction：选择流程图方向。
- Should reverse arrow：当默认关系方向与所需工作流程展示方式不一致时，反转连接箭头方向。
- Submit：保存配置并返回渲染后的流程图。
配置
初始设置
确认表中包含使用 ForeignKey 或 ForeignKeys 小插件的列。
确认多条记录通过同一个关系列相互引用。
在要显示关系的记录中，添加一个使用 Relation Flowchart 小插件的章节。
点击 Edit 打开小插件配置。
选择关系 Column 和可选的 Text Column，设置图表 Direction，并决定是否启用 Should reverse arrow。
点击 Submit 保存配置并生成流程图。
必需设置
- Column：选择定义要显示记录关系的 ForeignKey 或 ForeignKeys 列。
可选设置
- Text Column：选择一个文本列，在关联记录之间显示标签。选择 Self 使用关系列名称，或选择 None 隐藏连接文本。
- Direction：设置流程图方向，使关系符合工作流程的自然阅读顺序，例如从上到下或从左到右。
- Should reverse arrow：当可视化流程应指向与存储关系相反的方向时，反转箭头方向。
所选列必须包含有效的记录引用。如果记录未通过同一个 ForeignKey 或 ForeignKeys 列关联，流程图可能不完整。
其他功能
显示单一关系路径
当每条记录应引用一条相关记录时，使用 ForeignKey 列。这会创建单一关系路径，适合存储层级、父子关系或只有一个直接来源的记录。
显示多条关系路径
当每条记录可以引用多条相关记录时，使用 ForeignKeys 列。这会在流程图中创建多条路径，适合样本混合、多输入工作流程、共享试剂或连接到多个上游来源的记录。
打开相关记录
点击流程图中的方框，打开相关记录的更多详细信息。因此，该流程图既可用于可视化，也可作为关联数据的导航工具。
反转箭头方向
如果存储的关系方向适合数据模型，但相反方向更便于读者理解，请启用 Should reverse arrow。例如，存储记录可能指向其父位置，而从位置指向其中内容的图表可能更易阅读。
最佳实践
- 使用清晰的记录名称，使每个流程图方框无需额外上下文即可理解。
- 对简单的一对一或子级到父级关系使用 ForeignKey。
- 当记录可以连接到多个上游或下游记录时，使用 ForeignKeys。
- 如果仅凭记录名称无法明确关系含义，请添加连接文本。
- 对于非常大的关系网络，选择最相关的关系列，使图表保持聚焦。
- 从读者视角检查箭头方向，尤其是样本谱系和存储层级图。
对于可追溯性工作流程，请结合一致的关系列和清晰的记录命名。每个节点和连接线能够一目了然地说明其作用时，流程图会更易于审计。
相关小插件
- Record List by ForeignKey：显示通过 ForeignKey 或 ForeignKeys 列引用当前记录的记录。
- Record List by Column：显示按 ForeignKey 或 ForeignKeys 列中的值组织的记录。
- Record Timeline by ForeignKey：以时间顺序为主要关注点时，按时间顺序显示关联记录。
- Section Display By ForeignKey：通过 ForeignKey 或 ForeignKeys 引用显示相关记录中的章节。
- Stage Flowchart：显示预定义状态阶段中的进展，而非记录之间的关系。
- Mermaid：关系结构未存储在 Labii 列中时，手动创建自定义图表。